Cleaned Javadoc.

This commit is contained in:
Christian P. MOMON 2018-01-04 23:28:30 +01:00
parent 1d21c44dab
commit 00215b796c
7 changed files with 30 additions and 17 deletions

View File

@ -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) public String getNotifyCron(final String notifyName)
{ {

View File

@ -41,8 +41,10 @@ public class CronListener implements TriggerListener
/** /**
* Instantiates a new cron listener. * Instantiates a new cron listener.
* *
* @param name * @param bot
* the name * the bot
* @param cron
* the cron
*/ */
public CronListener(final Hebdobot bot, final CronValue cron) public CronListener(final Hebdobot bot, final CronValue cron)
{ {

View File

@ -50,7 +50,10 @@ public class CronManager
* *
* @param bot * @param bot
* the bot * the bot
* @param crons
* the crons
* @throws SchedulerException * @throws SchedulerException
* the scheduler exception
*/ */
public CronManager(final Hebdobot bot, final CronSettings crons) throws SchedulerException public CronManager(final Hebdobot bot, final CronSettings crons) throws SchedulerException
{ {
@ -67,7 +70,10 @@ public class CronManager
/** /**
* Adds the cron. * Adds the cron.
* *
* @param cron
* the cron
* @throws SchedulerException * @throws SchedulerException
* the scheduler exception
*/ */
public void addCron(final CronValue cron) throws SchedulerException public void addCron(final CronValue cron) throws SchedulerException
{ {

View File

@ -74,7 +74,7 @@ public class Hebdobot extends PircBot
private CronManager cronManager; private CronManager cronManager;
/** /**
* Instantiates a new bot. * Instantiates a new hebdobot.
* *
* @param host * @param host
* the host * the host
@ -84,6 +84,10 @@ public class Hebdobot extends PircBot
* the name * the name
* @param channel * @param channel
* the 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, public Hebdobot(final String host, final int port, final String name, final String channel, final File homeDirectory,
final String reviewFileSuffix) final String reviewFileSuffix)
@ -175,10 +179,10 @@ public class Hebdobot extends PircBot
} }
/** /**
* Notify. * Notify irc.
* *
* @param minutes * @param message
* the minutes * the message
*/ */
public void notifyIrc(final String message) public void notifyIrc(final String message)
{ {
@ -519,7 +523,7 @@ public class Hebdobot extends PircBot
else else
{ {
logger.info("Else caught."); logger.info("Else caught.");
// All the other. // All the other.
if (this.review != null) if (this.review != null)
{ {
@ -577,11 +581,10 @@ public class Hebdobot extends PircBot
} }
/** /**
* Inits the. * Run.
*
* the exception
* *
* @throws HebdobotException * @throws HebdobotException
* the hebdobot exception
*/ */
public void run() throws HebdobotException public void run() throws HebdobotException
{ {

View File

@ -51,6 +51,8 @@ public class Review
* *
* @param owner * @param owner
* the owner * the owner
* @param aliases
* the aliases
*/ */
public Review(final String owner, final UserAliases aliases) public Review(final String owner, final UserAliases aliases)
{ {

View File

@ -80,11 +80,12 @@ public class TwitterClient
} }
/** /**
* Send tweet. * Tweet.
* *
* @param message * @param message
* the message * the message
* @throws TwitterException * @throws TwitterException
* the twitter exception
*/ */
public void tweet(final String message) throws TwitterException public void tweet(final String message) throws TwitterException
{ {

View File

@ -31,10 +31,7 @@ public class TwitterSettings
private String accessTokenSecret; private String accessTokenSecret;
/** /**
* Instantiates a new pastebin settings. * Instantiates a new twitter settings.
*
* @param apiKey
* the api key
*/ */
public TwitterSettings() public TwitterSettings()
{ {