[Cherbot-commit] SF.net SVN: cherbot: [43] trunk/src/net/sf/cherbot
Status: Alpha
Brought to you by:
christianhujer
Menu
▾
▴
[Cherbot-commit] SF.net SVN: cherbot: [43] trunk/src/net/sf/cherbot
|
From: <chr...@us...> - 2007-02-10 21:45:35
|
Revision: 43
http://svn.sourceforge.net/cherbot/?rev=43&view=rev
Author: christianhujer
Date: 2007-02-10 13:45:34 -0800 (Sat, 10 Feb 2007)
Log Message:
-----------
Fixed some javadoc issues.
Modified Paths:
--------------
trunk/src/net/sf/cherbot/CherBotSecurityManager.java
trunk/src/net/sf/cherbot/Crime.java
trunk/src/net/sf/cherbot/CrimeManager.java
trunk/src/net/sf/cherbot/GroupManager.java
trunk/src/net/sf/cherbot/Manager.java
trunk/src/net/sf/cherbot/ManagerDocumenter.java
trunk/src/net/sf/cherbot/NoobManager.java
trunk/src/net/sf/cherbot/PlayerManager.java
trunk/src/net/sf/cherbot/PollManager.java
trunk/src/net/sf/cherbot/RodBabyManager.java
trunk/src/net/sf/cherbot/RodBabyWannabeManager.java
trunk/src/net/sf/cherbot/SalesManager.java
trunk/src/net/sf/cherbot/TimeManager.java
Modified: trunk/src/net/sf/cherbot/CherBotSecurityManager.java
===================================================================
--- trunk/src/net/sf/cherbot/CherBotSecurityManager.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/CherBotSecurityManager.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -166,7 +166,7 @@
}
/**
- * Revoke permission to someoneon something
+ * Revoke permission to someoneon something.
* @param player whose permissions are to be revoked
* @param permission Permissions to revoke
*/
Modified: trunk/src/net/sf/cherbot/Crime.java
===================================================================
--- trunk/src/net/sf/cherbot/Crime.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/Crime.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -7,6 +7,7 @@
package net.sf.cherbot;
/**
+ * Manager for Crimes.
* TODO
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
*/
Modified: trunk/src/net/sf/cherbot/CrimeManager.java
===================================================================
--- trunk/src/net/sf/cherbot/CrimeManager.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/CrimeManager.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -167,6 +167,7 @@
//
/**
+ * Create a new CrimeManager.
* @param cherBot reference to CherBot.
*/
public CrimeManager(final CherBot cherBot) {
Modified: trunk/src/net/sf/cherbot/GroupManager.java
===================================================================
--- trunk/src/net/sf/cherbot/GroupManager.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/GroupManager.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -1103,6 +1103,7 @@
}
/**
+ * Deserialize a Group.
* Implementation for deserialization:
* Take care about newly added fields
* @param stream Stream to deserialize with
Modified: trunk/src/net/sf/cherbot/Manager.java
===================================================================
--- trunk/src/net/sf/cherbot/Manager.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/Manager.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -235,7 +235,7 @@
}
/**
- * Returns the level of a player
+ * Returns the level of a player.
* @param player Player to get level of
* @return level of player or 0 if unknown
*/
@@ -1343,7 +1343,7 @@
} // @interface Description
/**
- * Annotatin to document the features of a module / Manager
+ * Annotation to document the features of a module / Manager.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
*/
@Retention(RUNTIME)
Modified: trunk/src/net/sf/cherbot/ManagerDocumenter.java
===================================================================
--- trunk/src/net/sf/cherbot/ManagerDocumenter.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/ManagerDocumenter.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -28,6 +28,7 @@
/**
* Main program.
* @param args command line arguments
+ * @throws Exception in case of errors.
*/
public static void main(final String... args) throws Exception {
final CherBot bot = new CherBot();
@@ -77,7 +78,7 @@
}
/**
- * Create a command element for a command
+ * Create a command element for a command.
* @param command Command to create element for
* @return element for Command
*/
Modified: trunk/src/net/sf/cherbot/NoobManager.java
===================================================================
--- trunk/src/net/sf/cherbot/NoobManager.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/NoobManager.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -210,7 +210,7 @@
}
/**
- * Get the whereis on a specific topic
+ * Get the whereis on a specific topic.
* @param topic topic to get whereis on
*/
private void getWhereis(final String topic) {
@@ -233,7 +233,7 @@
}
/**
- * Get the whatis on a specific topic
+ * Get the whatis on a specific topic.
* @param topic topic to get whatis on
*/
private void getWhatis(final String topic) {
Modified: trunk/src/net/sf/cherbot/PlayerManager.java
===================================================================
--- trunk/src/net/sf/cherbot/PlayerManager.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/PlayerManager.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -789,6 +789,7 @@
/**
* Create a LevelManager.
+ * @param cherBot CherBot instance to use.
*/
public PlayerManager(final CherBot cherBot) {
super(cherBot, "players", 2000);
Modified: trunk/src/net/sf/cherbot/PollManager.java
===================================================================
--- trunk/src/net/sf/cherbot/PollManager.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/PollManager.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -262,7 +262,7 @@
}
/**
- * Get the minimum level for the creation of polls
+ * Get the minimum level for the creation of polls.
* @return minimum level for the creation of polls
*/
private int getMinLevel() {
@@ -554,6 +554,7 @@
/**
* Get the number of votes for a choice of a poll.
* @param choice index of to get number of votes for (1..num_choices)
+ * @return the votes for this poll.
*/
int getVotes(final int choice) {
if (choice > choices.size() || choice < 1) {
@@ -565,6 +566,7 @@
/**
* Get the number of botes for a choice of a poll.
* @param choice choice
+ * @return the votes for this choice.
*/
int getVotes(final String choice) {
return votes.get(choice)[0];
@@ -644,7 +646,7 @@
* @param out PrintWriter to write to
* @throws IOException in case of I/O problems
*/
- void writeTo(final PrintWriter out) throws EOFException, IOException {
+ void writeTo(final PrintWriter out) throws IOException {
out.println(number + ": " + getNumChoices() + ": " + state + ": " + player);
out.println(title);
out.println(description);
Modified: trunk/src/net/sf/cherbot/RodBabyManager.java
===================================================================
--- trunk/src/net/sf/cherbot/RodBabyManager.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/RodBabyManager.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -114,6 +114,7 @@
/**
* Create a LevelManager.
+ * @param cherBot CherBot to use.
*/
public RodBabyManager(final CherBot cherBot) {
super(cherBot, "rodbabies");
Modified: trunk/src/net/sf/cherbot/RodBabyWannabeManager.java
===================================================================
--- trunk/src/net/sf/cherbot/RodBabyWannabeManager.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/RodBabyWannabeManager.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -114,6 +114,7 @@
/**
* Create a LevelManager.
+ * @param cherBot CherBot to use.
*/
public RodBabyWannabeManager(final CherBot cherBot) {
super(cherBot, "rodbabywannabes");
Modified: trunk/src/net/sf/cherbot/SalesManager.java
===================================================================
--- trunk/src/net/sf/cherbot/SalesManager.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/SalesManager.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -12,6 +12,7 @@
import java.util.regex.Matcher;
/**
+ * Manager for sales.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
*/
@Manager.Description("Allows to place sales adds.")
Modified: trunk/src/net/sf/cherbot/TimeManager.java
===================================================================
--- trunk/src/net/sf/cherbot/TimeManager.java 2007-02-10 21:22:37 UTC (rev 42)
+++ trunk/src/net/sf/cherbot/TimeManager.java 2007-02-10 21:45:34 UTC (rev 43)
@@ -264,6 +264,7 @@
* Create a time by cloning another time.
* I've not implemented Cloneable because cloning normally is not required because normally instances are immuntable.
* But the one single instance used by the TimeManager is mutable, so that's the only usage of this constructor.
+ * @param o Other time for creating a clone.
*/
private Time(final Time o) {
this(o.year, o.month, o.day, o.hours, o.minutes);
@@ -339,7 +340,7 @@
* {@inheritDoc}
*/
@Override public int hashCode() {
- return (year << 24) ^ (month << 19) ^ (day << 13) ^ (hours << 7) ^ (minutes << 0);
+ return (year << 24) ^ (month << 19) ^ (day << 13) ^ (hours << 7) ^ (minutes);
}
/**
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
