From 058b902fbdf47b4714371ae87e828108bc4802a2 Mon Sep 17 00:00:00 2001 From: "Christian P. MOMON" Date: Fri, 11 Mar 2022 14:54:52 +0100 Subject: [PATCH] Javadoc review. --- .../statoolinfos/metrics/minetest/MinetestProber.java | 11 ++++++++--- .../statoolinfos/metrics/util/DatabaseProber.java | 4 ++-- src/fr/devinsy/statoolinfos/util/sql/SQLDatabase.java | 6 ++---- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/src/fr/devinsy/statoolinfos/metrics/minetest/MinetestProber.java b/src/fr/devinsy/statoolinfos/metrics/minetest/MinetestProber.java index fae15a4..c4953a3 100644 --- a/src/fr/devinsy/statoolinfos/metrics/minetest/MinetestProber.java +++ b/src/fr/devinsy/statoolinfos/metrics/minetest/MinetestProber.java @@ -50,10 +50,15 @@ public class MinetestProber * * @param logs * the logs - * @param databaseConfig - * the database config - * @throws StatoolInfosException + * @param playerDatabaseConfig + * the player database config + * @param worldDatabaseConfig + * the world database config + * @return the path counters * @throws IOException + * Signals that an I/O exception has occurred. + * @throws StatoolInfosException + * the statool infos exception */ public static PathCounters probe(final String logs, final DatabaseConfig playerDatabaseConfig, final DatabaseConfig worldDatabaseConfig) throws IOException, StatoolInfosException { diff --git a/src/fr/devinsy/statoolinfos/metrics/util/DatabaseProber.java b/src/fr/devinsy/statoolinfos/metrics/util/DatabaseProber.java index ad4a0eb..960e5d7 100644 --- a/src/fr/devinsy/statoolinfos/metrics/util/DatabaseProber.java +++ b/src/fr/devinsy/statoolinfos/metrics/util/DatabaseProber.java @@ -44,8 +44,8 @@ public class DatabaseProber /** * Probe. * - * @param config - * the config + * @param database + * the database * @return the path counters * @throws IOException * Signals that an I/O exception has occurred. diff --git a/src/fr/devinsy/statoolinfos/util/sql/SQLDatabase.java b/src/fr/devinsy/statoolinfos/util/sql/SQLDatabase.java index ed6fc49..25ef64d 100644 --- a/src/fr/devinsy/statoolinfos/util/sql/SQLDatabase.java +++ b/src/fr/devinsy/statoolinfos/util/sql/SQLDatabase.java @@ -60,10 +60,8 @@ public class SQLDatabase private Connection connection; /** - * This method opens a database session. - * - * @param driverClassName - * the driver class name + * Instantiates a new SQL database. + * * @param url * the url * @param login