From 07b337aac0c136e2a30ad24addf5a0c341aa9907 Mon Sep 17 00:00:00 2001 From: "Christian P. MOMON" Date: Thu, 10 Jun 2021 16:03:50 +0200 Subject: [PATCH] Made Javadoc review. --- build.num.tmp | 3 --- .../statoolinfos/htmlize/FederationUptimePage.java | 5 +++-- .../htmlize/OrganizationMetricGenericPage.java | 11 +++++++++-- .../htmlize/OrganizationMetricSummaryPage.java | 9 +++++++-- .../statoolinfos/stats/useragent/UserAgentStat.java | 2 -- .../stats/useragent/UserAgentStatSet.java | 7 ++----- src/fr/devinsy/statoolinfos/uptime/UptimeStat.java | 5 +---- 7 files changed, 22 insertions(+), 20 deletions(-) delete mode 100644 build.num.tmp diff --git a/build.num.tmp b/build.num.tmp deleted file mode 100644 index 67d3912..0000000 --- a/build.num.tmp +++ /dev/null @@ -1,3 +0,0 @@ -#Build Number for ANT. Do not edit! -#Sun Sep 13 02:31:30 CEST 2020 -build.number=0 diff --git a/src/fr/devinsy/statoolinfos/htmlize/FederationUptimePage.java b/src/fr/devinsy/statoolinfos/htmlize/FederationUptimePage.java index a6c4419..ea9624c 100644 --- a/src/fr/devinsy/statoolinfos/htmlize/FederationUptimePage.java +++ b/src/fr/devinsy/statoolinfos/htmlize/FederationUptimePage.java @@ -62,14 +62,15 @@ public class FederationUptimePage /** * Htmlize. * - * @param services - * the services + * @param federation + * the federation * @param journal * the journal * @return the string * @throws StatoolInfosException * the statool infos exception * @throws IOException + * Signals that an I/O exception has occurred. */ public static String htmlize(final Federation federation, final UptimeJournal journal) throws StatoolInfosException, IOException { diff --git a/src/fr/devinsy/statoolinfos/htmlize/OrganizationMetricGenericPage.java b/src/fr/devinsy/statoolinfos/htmlize/OrganizationMetricGenericPage.java index 2ff4de4..442d5a8 100644 --- a/src/fr/devinsy/statoolinfos/htmlize/OrganizationMetricGenericPage.java +++ b/src/fr/devinsy/statoolinfos/htmlize/OrganizationMetricGenericPage.java @@ -46,11 +46,18 @@ public class OrganizationMetricGenericPage /** * Builds the. * + * @param htmlizeDirectory + * the htmlize directory * @param organization - * the service - * @return the string + * the organization + * @param view + * the view + * @param period + * the period * @throws StatoolInfosException * the statool infos exception + * @throws IOException + * Signals that an I/O exception has occurred. */ public static void build(final File htmlizeDirectory, final Organization organization, final ViewMenu view, final PeriodMenu period) throws StatoolInfosException, IOException { diff --git a/src/fr/devinsy/statoolinfos/htmlize/OrganizationMetricSummaryPage.java b/src/fr/devinsy/statoolinfos/htmlize/OrganizationMetricSummaryPage.java index 7880df8..59b4463 100644 --- a/src/fr/devinsy/statoolinfos/htmlize/OrganizationMetricSummaryPage.java +++ b/src/fr/devinsy/statoolinfos/htmlize/OrganizationMetricSummaryPage.java @@ -44,11 +44,16 @@ public class OrganizationMetricSummaryPage private static Logger logger = LoggerFactory.getLogger(OrganizationMetricSummaryPage.class); /** - * Htmlize. + * Builds the. * + * @param htmlizeDirectory + * the htmlize directory * @param organization * the organization - * @return the string + * @param view + * the view + * @param period + * the period * @throws StatoolInfosException * the statool infos exception * @throws IOException diff --git a/src/fr/devinsy/statoolinfos/stats/useragent/UserAgentStat.java b/src/fr/devinsy/statoolinfos/stats/useragent/UserAgentStat.java index 5db49e8..3cafc0e 100644 --- a/src/fr/devinsy/statoolinfos/stats/useragent/UserAgentStat.java +++ b/src/fr/devinsy/statoolinfos/stats/useragent/UserAgentStat.java @@ -41,8 +41,6 @@ public final class UserAgentStat /** * Instantiates a new user agent stat. * - * @param ip - * the ip * @param userAgent * the user agent */ diff --git a/src/fr/devinsy/statoolinfos/stats/useragent/UserAgentStatSet.java b/src/fr/devinsy/statoolinfos/stats/useragent/UserAgentStatSet.java index bdb08be..0a55013 100644 --- a/src/fr/devinsy/statoolinfos/stats/useragent/UserAgentStatSet.java +++ b/src/fr/devinsy/statoolinfos/stats/useragent/UserAgentStatSet.java @@ -25,7 +25,6 @@ import org.slf4j.LoggerFactory; import fr.devinsy.statoolinfos.metrics.http.HttpAccessLog; -// TODO: Auto-generated Javadoc /** * The Class UserAgents. */ @@ -46,10 +45,8 @@ public final class UserAgentStatSet extends HashMap /** * Put. * - * @param ip - * the ip - * @param userAgent - * the user agent + * @param log + * the log */ public void put(final HttpAccessLog log) { diff --git a/src/fr/devinsy/statoolinfos/uptime/UptimeStat.java b/src/fr/devinsy/statoolinfos/uptime/UptimeStat.java index 57c423d..1801d5d 100644 --- a/src/fr/devinsy/statoolinfos/uptime/UptimeStat.java +++ b/src/fr/devinsy/statoolinfos/uptime/UptimeStat.java @@ -34,10 +34,7 @@ public class UptimeStat private UptimeStatus last; /** - * Instantiates a new uptime check. - * - * @param url - * the url + * Instantiates a new uptime stat. */ public UptimeStat() {