Cleaned Javadoc.

This commit is contained in:
Christian P. MOMON 2018-05-19 10:47:58 +02:00
parent 3b590fbd09
commit 5d318ea889
7 changed files with 23 additions and 19 deletions

View File

@ -350,6 +350,7 @@ public class HebdobotConfigFile extends Properties
*
* @return the review wait time
* @throws HebdobotException
* the Hebdobot exception
*/
public LocalTime getReviewWaitTime() throws HebdobotException
{

View File

@ -37,11 +37,13 @@ public class CronValue
* @param name
* the name
* @param cron
* the value
* the cron
* @param ircMessage
* the irc message
* @param twitterMessage
* the twitter message
* @param imageFile
* the image file
*/
public CronValue(final String name, final String cron, final String ircMessage, final String twitterMessage, final File imageFile)
{

View File

@ -100,8 +100,6 @@ public class Hebdobot extends PircBot
* the home directory
* @param reviewDirectory
* the review 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 File reviewDirectory)
{

View File

@ -49,7 +49,6 @@ public class IntegerBoard implements Iterable<IntegerStat>
*
* @param value
* the value
* @return true, if successful
*/
public void add(final Integer value)
{
@ -178,11 +177,11 @@ public class IntegerBoard implements Iterable<IntegerStat>
}
/**
* Gets the index of.
* Gets the position of board item.
*
* @param value
* the value
* @return the index of
* @param search
* the search
* @return the position of
*/
public Integer getPositionOf(final int search)
{

View File

@ -56,10 +56,11 @@ public class ReviewDatasFile
* Append.
*
* @param file
* the target
* the file
* @param stat
* the stat
* @throws HebdobotException
* the hebdobot exception
*/
public static void append(final File file, final ReviewData stat) throws HebdobotException
{
@ -93,8 +94,9 @@ public class ReviewDatasFile
*
* @param source
* the source
* @return the stats
* @return the review datas
* @throws HebdobotException
* the hebdobot exception
*/
public static ReviewDatas load(final File source) throws HebdobotException
{
@ -142,10 +144,11 @@ public class ReviewDatasFile
/**
* Read.
*
* @param source
* the source
* @return the stats
* @param in
* the in
* @return the review datas
* @throws IOException
* Signals that an I/O exception has occurred.
*/
public static ReviewDatas read(final BufferedReader in) throws IOException
{

View File

@ -71,11 +71,11 @@ public class SimpleIntegerBoard implements Iterable<Integer>
}
/**
* Gets the index of.
* Gets the position of the board entry.
*
* @param value
* the value
* @return the index of
* @param search
* the search
* @return the position of
*/
public Integer getPositionOf(final int search)
{

View File

@ -87,6 +87,7 @@ public class TwitterClient
*
* @param message
* the message
* @return the status
* @throws TwitterException
* the twitter exception
*/
@ -105,8 +106,8 @@ public class TwitterClient
*
* @param message
* the message
* @param image
* the image
* @param imageFile
* the image file
* @return the status
* @throws TwitterException
* the twitter exception