[Cherbot-commit] SF.net SVN: cherbot: [61] trunk/src/net/sf/cherbot

[<chr...@us...>]

Revision: 61
          http://svn.sourceforge.net/cherbot/?rev=61&view=rev
Author:   christianhujer
Date:     2007-06-16 13:51:19 -0700 (Sat, 16 Jun 2007)

Log Message:
-----------
Added package documentation. Improved javadoc comments and documentation.

Modified Paths:
--------------
    trunk/src/net/sf/cherbot/AbstractConnection.java
    trunk/src/net/sf/cherbot/ClanModule.java
    trunk/src/net/sf/cherbot/Module.java

Added Paths:
-----------
    trunk/src/net/sf/cherbot/metaserver/package-info.java
    trunk/src/net/sf/cherbot/package-info.java

Modified: trunk/src/net/sf/cherbot/AbstractConnection.java
===================================================================
--- trunk/src/net/sf/cherbot/AbstractConnection.java	2007-06-16 20:22:54 UTC (rev 60)
+++ trunk/src/net/sf/cherbot/AbstractConnection.java	2007-06-16 20:51:19 UTC (rev 61)
@@ -6,7 +6,7 @@
 
 package net.sf.cherbot;
 
-/** A AbstractConnection represents the connection to a server and has one or more channels.
+/** An AbstractConnection represents the connection to a server and has one or more channels.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  */
 public abstract class AbstractConnection {

Modified: trunk/src/net/sf/cherbot/ClanModule.java
===================================================================
--- trunk/src/net/sf/cherbot/ClanModule.java	2007-06-16 20:22:54 UTC (rev 60)
+++ trunk/src/net/sf/cherbot/ClanModule.java	2007-06-16 20:51:19 UTC (rev 61)
@@ -9,8 +9,7 @@
 import org.jetbrains.annotations.NotNull;
 import java.sql.Connection;
 
-/**
- * Created by IntelliJ IDEA.
+/** Module for Clans.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  */
 public class ClanModule implements PersistentModule {
@@ -23,7 +22,8 @@
     public void save(@NotNull final Connection con) {
     }
 
-    public void parseMessage(@NotNull Channel channel, @NotNull String msg) {
-        //To change body of implemented methods use File | Settings | File Templates.
+    /** {@inheritDoc} */
+    public void parseMessage(@NotNull final Channel channel, @NotNull final String msg) {
     }
+
 } // class ClanModule

Modified: trunk/src/net/sf/cherbot/Module.java
===================================================================
--- trunk/src/net/sf/cherbot/Module.java	2007-06-16 20:22:54 UTC (rev 60)
+++ trunk/src/net/sf/cherbot/Module.java	2007-06-16 20:51:19 UTC (rev 61)
@@ -1,3 +1,9 @@
+/*
+ * Copyright © 2007, Christian Hujer and the CherBot developers. All Rights Reserved.
+ * License: GNU General Public License v2.0 or newer.
+ * See file COPYING in the root directory of this project.
+ */
+
 package net.sf.cherbot;
 
 import org.jetbrains.annotations.NotNull;
@@ -2,4 +8,3 @@
 
-/**
- * Created by IntelliJ IDEA.
+/** Interface for Modules.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
@@ -13,4 +18,5 @@
      * @param msg Message to parse
      */
     void parseMessage(@NotNull Channel channel, @NotNull String msg);
-}
+
+} // interface Module

Added: trunk/src/net/sf/cherbot/metaserver/package-info.java
===================================================================
--- trunk/src/net/sf/cherbot/metaserver/package-info.java	                        (rev 0)
+++ trunk/src/net/sf/cherbot/metaserver/package-info.java	2007-06-16 20:51:19 UTC (rev 61)
@@ -0,0 +1,10 @@
+/*
+ * Copyright © 2007, Christian Hujer and the CherBot developers. All Rights Reserved.
+ * License: GNU General Public License v2.0 or newer.
+ * See file COPYING in the root directory of this project.
+ */
+
+/** The package net.sf.cherbot.metaserver contains metaserver access.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ */
+package net.sf.cherbot.metaserver;


Property changes on: trunk/src/net/sf/cherbot/metaserver/package-info.java
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + LF

Added: trunk/src/net/sf/cherbot/package-info.java
===================================================================
--- trunk/src/net/sf/cherbot/package-info.java	                        (rev 0)
+++ trunk/src/net/sf/cherbot/package-info.java	2007-06-16 20:51:19 UTC (rev 61)
@@ -0,0 +1,10 @@
+/*
+ * Copyright © 2007, Christian Hujer and the CherBot developers. All Rights Reserved.
+ * License: GNU General Public License v2.0 or newer.
+ * See file COPYING in the root directory of this project.
+ */
+
+/** The package net.sf.cherbot contains the main classes of CherBot.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ */
+package net.sf.cherbot;


Property changes on: trunk/src/net/sf/cherbot/package-info.java
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + LF


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.