From 00215b796c8f1062a9d8683bc85dc0e5a01ad08a Mon Sep 17 00:00:00 2001 From: "Christian P. MOMON" Date: Thu, 4 Jan 2018 23:28:30 +0100 Subject: [PATCH] Cleaned Javadoc. --- .../hebdobot/cli/HebdobotConfigFile.java | 6 ++++-- src/org/april/hebdobot/cron/CronListener.java | 6 ++++-- src/org/april/hebdobot/cron/CronManager.java | 6 ++++++ src/org/april/hebdobot/model/Hebdobot.java | 19 +++++++++++-------- src/org/april/hebdobot/review/Review.java | 2 ++ .../april/hebdobot/twitter/TwitterClient.java | 3 ++- .../hebdobot/twitter/TwitterSettings.java | 5 +---- 7 files changed, 30 insertions(+), 17 deletions(-) diff --git a/src/org/april/hebdobot/cli/HebdobotConfigFile.java b/src/org/april/hebdobot/cli/HebdobotConfigFile.java index 7894161..de36a7c 100644 --- a/src/org/april/hebdobot/cli/HebdobotConfigFile.java +++ b/src/org/april/hebdobot/cli/HebdobotConfigFile.java @@ -190,9 +190,11 @@ public class HebdobotConfigFile extends Properties } /** - * Gets the notification names. + * Gets the notify cron. * - * @return the notification names + * @param notifyName + * the notify name + * @return the notify cron */ public String getNotifyCron(final String notifyName) { diff --git a/src/org/april/hebdobot/cron/CronListener.java b/src/org/april/hebdobot/cron/CronListener.java index 9626183..8ccbc00 100644 --- a/src/org/april/hebdobot/cron/CronListener.java +++ b/src/org/april/hebdobot/cron/CronListener.java @@ -41,8 +41,10 @@ public class CronListener implements TriggerListener /** * Instantiates a new cron listener. * - * @param name - * the name + * @param bot + * the bot + * @param cron + * the cron */ public CronListener(final Hebdobot bot, final CronValue cron) { diff --git a/src/org/april/hebdobot/cron/CronManager.java b/src/org/april/hebdobot/cron/CronManager.java index 4823a4b..305daba 100644 --- a/src/org/april/hebdobot/cron/CronManager.java +++ b/src/org/april/hebdobot/cron/CronManager.java @@ -50,7 +50,10 @@ public class CronManager * * @param bot * the bot + * @param crons + * the crons * @throws SchedulerException + * the scheduler exception */ public CronManager(final Hebdobot bot, final CronSettings crons) throws SchedulerException { @@ -67,7 +70,10 @@ public class CronManager /** * Adds the cron. * + * @param cron + * the cron * @throws SchedulerException + * the scheduler exception */ public void addCron(final CronValue cron) throws SchedulerException { diff --git a/src/org/april/hebdobot/model/Hebdobot.java b/src/org/april/hebdobot/model/Hebdobot.java index cbd7085..dccf849 100644 --- a/src/org/april/hebdobot/model/Hebdobot.java +++ b/src/org/april/hebdobot/model/Hebdobot.java @@ -74,7 +74,7 @@ public class Hebdobot extends PircBot private CronManager cronManager; /** - * Instantiates a new bot. + * Instantiates a new hebdobot. * * @param host * the host @@ -84,6 +84,10 @@ public class Hebdobot extends PircBot * the name * @param channel * the channel + * @param homeDirectory + * the home directory + * @param reviewFileSuffix + * the review file suffix */ public Hebdobot(final String host, final int port, final String name, final String channel, final File homeDirectory, final String reviewFileSuffix) @@ -175,10 +179,10 @@ public class Hebdobot extends PircBot } /** - * Notify. + * Notify irc. * - * @param minutes - * the minutes + * @param message + * the message */ public void notifyIrc(final String message) { @@ -519,7 +523,7 @@ public class Hebdobot extends PircBot else { logger.info("Else caught."); - + // All the other. if (this.review != null) { @@ -577,11 +581,10 @@ public class Hebdobot extends PircBot } /** - * Inits the. - * - * the exception + * Run. * * @throws HebdobotException + * the hebdobot exception */ public void run() throws HebdobotException { diff --git a/src/org/april/hebdobot/review/Review.java b/src/org/april/hebdobot/review/Review.java index 0520023..5117878 100644 --- a/src/org/april/hebdobot/review/Review.java +++ b/src/org/april/hebdobot/review/Review.java @@ -51,6 +51,8 @@ public class Review * * @param owner * the owner + * @param aliases + * the aliases */ public Review(final String owner, final UserAliases aliases) { diff --git a/src/org/april/hebdobot/twitter/TwitterClient.java b/src/org/april/hebdobot/twitter/TwitterClient.java index a5000de..89f05aa 100644 --- a/src/org/april/hebdobot/twitter/TwitterClient.java +++ b/src/org/april/hebdobot/twitter/TwitterClient.java @@ -80,11 +80,12 @@ public class TwitterClient } /** - * Send tweet. + * Tweet. * * @param message * the message * @throws TwitterException + * the twitter exception */ public void tweet(final String message) throws TwitterException { diff --git a/src/org/april/hebdobot/twitter/TwitterSettings.java b/src/org/april/hebdobot/twitter/TwitterSettings.java index bf5f61e..582b512 100644 --- a/src/org/april/hebdobot/twitter/TwitterSettings.java +++ b/src/org/april/hebdobot/twitter/TwitterSettings.java @@ -31,10 +31,7 @@ public class TwitterSettings private String accessTokenSecret; /** - * Instantiates a new pastebin settings. - * - * @param apiKey - * the api key + * Instantiates a new twitter settings. */ public TwitterSettings() {