Cleaned Javadoc.
This commit is contained in:
parent
3b590fbd09
commit
5d318ea889
|
@ -350,6 +350,7 @@ public class HebdobotConfigFile extends Properties
|
||||||
*
|
*
|
||||||
* @return the review wait time
|
* @return the review wait time
|
||||||
* @throws HebdobotException
|
* @throws HebdobotException
|
||||||
|
* the Hebdobot exception
|
||||||
*/
|
*/
|
||||||
public LocalTime getReviewWaitTime() throws HebdobotException
|
public LocalTime getReviewWaitTime() throws HebdobotException
|
||||||
{
|
{
|
||||||
|
|
|
@ -37,11 +37,13 @@ public class CronValue
|
||||||
* @param name
|
* @param name
|
||||||
* the name
|
* the name
|
||||||
* @param cron
|
* @param cron
|
||||||
* the value
|
* the cron
|
||||||
* @param ircMessage
|
* @param ircMessage
|
||||||
* the irc message
|
* the irc message
|
||||||
* @param twitterMessage
|
* @param twitterMessage
|
||||||
* the twitter message
|
* 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)
|
public CronValue(final String name, final String cron, final String ircMessage, final String twitterMessage, final File imageFile)
|
||||||
{
|
{
|
||||||
|
|
|
@ -100,8 +100,6 @@ public class Hebdobot extends PircBot
|
||||||
* the home directory
|
* the home directory
|
||||||
* @param reviewDirectory
|
* @param reviewDirectory
|
||||||
* the review directory
|
* 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)
|
public Hebdobot(final String host, final int port, final String name, final String channel, final File homeDirectory, final File reviewDirectory)
|
||||||
{
|
{
|
||||||
|
|
|
@ -49,7 +49,6 @@ public class IntegerBoard implements Iterable<IntegerStat>
|
||||||
*
|
*
|
||||||
* @param value
|
* @param value
|
||||||
* the value
|
* the value
|
||||||
* @return true, if successful
|
|
||||||
*/
|
*/
|
||||||
public void add(final Integer value)
|
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
|
* @param search
|
||||||
* the value
|
* the search
|
||||||
* @return the index of
|
* @return the position of
|
||||||
*/
|
*/
|
||||||
public Integer getPositionOf(final int search)
|
public Integer getPositionOf(final int search)
|
||||||
{
|
{
|
||||||
|
|
|
@ -56,10 +56,11 @@ public class ReviewDatasFile
|
||||||
* Append.
|
* Append.
|
||||||
*
|
*
|
||||||
* @param file
|
* @param file
|
||||||
* the target
|
* the file
|
||||||
* @param stat
|
* @param stat
|
||||||
* the stat
|
* the stat
|
||||||
* @throws HebdobotException
|
* @throws HebdobotException
|
||||||
|
* the hebdobot exception
|
||||||
*/
|
*/
|
||||||
public static void append(final File file, final ReviewData stat) throws HebdobotException
|
public static void append(final File file, final ReviewData stat) throws HebdobotException
|
||||||
{
|
{
|
||||||
|
@ -93,8 +94,9 @@ public class ReviewDatasFile
|
||||||
*
|
*
|
||||||
* @param source
|
* @param source
|
||||||
* the source
|
* the source
|
||||||
* @return the stats
|
* @return the review datas
|
||||||
* @throws HebdobotException
|
* @throws HebdobotException
|
||||||
|
* the hebdobot exception
|
||||||
*/
|
*/
|
||||||
public static ReviewDatas load(final File source) throws HebdobotException
|
public static ReviewDatas load(final File source) throws HebdobotException
|
||||||
{
|
{
|
||||||
|
@ -142,10 +144,11 @@ public class ReviewDatasFile
|
||||||
/**
|
/**
|
||||||
* Read.
|
* Read.
|
||||||
*
|
*
|
||||||
* @param source
|
* @param in
|
||||||
* the source
|
* the in
|
||||||
* @return the stats
|
* @return the review datas
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
* Signals that an I/O exception has occurred.
|
||||||
*/
|
*/
|
||||||
public static ReviewDatas read(final BufferedReader in) throws IOException
|
public static ReviewDatas read(final BufferedReader in) throws IOException
|
||||||
{
|
{
|
||||||
|
|
|
@ -71,11 +71,11 @@ public class SimpleIntegerBoard implements Iterable<Integer>
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the index of.
|
* Gets the position of the board entry.
|
||||||
*
|
*
|
||||||
* @param value
|
* @param search
|
||||||
* the value
|
* the search
|
||||||
* @return the index of
|
* @return the position of
|
||||||
*/
|
*/
|
||||||
public Integer getPositionOf(final int search)
|
public Integer getPositionOf(final int search)
|
||||||
{
|
{
|
||||||
|
|
|
@ -87,6 +87,7 @@ public class TwitterClient
|
||||||
*
|
*
|
||||||
* @param message
|
* @param message
|
||||||
* the message
|
* the message
|
||||||
|
* @return the status
|
||||||
* @throws TwitterException
|
* @throws TwitterException
|
||||||
* the twitter exception
|
* the twitter exception
|
||||||
*/
|
*/
|
||||||
|
@ -105,8 +106,8 @@ public class TwitterClient
|
||||||
*
|
*
|
||||||
* @param message
|
* @param message
|
||||||
* the message
|
* the message
|
||||||
* @param image
|
* @param imageFile
|
||||||
* the image
|
* the image file
|
||||||
* @return the status
|
* @return the status
|
||||||
* @throws TwitterException
|
* @throws TwitterException
|
||||||
* the twitter exception
|
* the twitter exception
|
||||||
|
|
Loading…
Reference in New Issue
Block a user