mud4j-commit

[mud4j-commit] SF.net SVN: mud4j: [34] trunk/mud4j-core/src/java/net/sf/mud4j/effect/ Effect.java

[<mpu...@us...>]

Revision: 34
          http://mud4j.svn.sourceforge.net/mud4j/?rev=34&view=rev
Author:   mpurland
Date:     2006-12-23 09:07:21 -0800 (Sat, 23 Dec 2006)

Log Message:
-----------
Use @todo tags.

Modified Paths:
--------------
    trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java

Modified: trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java
===================================================================
--- trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java	2006-12-23 17:06:57 UTC (rev 33)
+++ trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java	2006-12-23 17:07:21 UTC (rev 34)
@@ -19,10 +19,9 @@
 /**
  * Effect to provide addon effects for specific objects.
  * 
- * TODO use decorator pattern with effects with characters and items and others
+ * @todo use decorator pattern with effects with characters and items and others
  * 
  * @author Matthew Purland
- *
  */
 public interface Effect {
 


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

[mud4j-commit] SF.net SVN: mud4j: [137] trunk/mud4j-core/src/java/net/sf/mud4j/effect/ Effect.java

[<mpu...@us...>]

Revision: 137
          http://mud4j.svn.sourceforge.net/mud4j/?rev=137&view=rev
Author:   mpurland
Date:     2007-06-13 20:27:57 -0700 (Wed, 13 Jun 2007)

Log Message:
-----------
Format the class.

Modified Paths:
--------------
    trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java

Modified: trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java
===================================================================
--- trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java	2007-06-03 01:53:22 UTC (rev 136)
+++ trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java	2007-06-14 03:27:57 UTC (rev 137)
@@ -20,40 +20,45 @@
  * Effect to provide addon effects for specific objects.
  * 
  * @todo use decorator pattern with effects with characters and items and others
- * 
  * @author Matthew Purland
  */
 public interface Effect {
 
     /**
      * Apply effect on the target.
+     * 
      * @param target Target object to apply effect on.
      * @throws EffectException in case of an apply failure.
      */
     public void apply() throws EffectException;
-    
+
     /**
      * Undo the effect from the target.
+     * 
      * @param target Target object to remove effect from.
      * @throws EffectException in case of an undo failure.
      */
     public void undo() throws EffectException;
-    
+
     /**
      * Determine if the effect has expired duration.
+     * 
      * @return Returns whether the effect has expired yet.
      */
     public boolean hasExpired();
-    
+
     /**
-     * Determine if the effect is permanent.  Permanent status means
-     * that the effect cannot be removed.
-     * @return Retruns whether the effect is a permanent effect and cannot expire.
+     * Determine if the effect is permanent. Permanent status means that the
+     * effect cannot be removed.
+     * 
+     * @return Retruns whether the effect is a permanent effect and cannot
+     *         expire.
      */
     public boolean isPermanent();
-    
+
     /**
      * Get name of the effect.
+     * 
      * @return Returns the name of the effect.
      */
     public String getName();


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

[mud4j-commit] SF.net SVN: mud4j: [138] trunk/mud4j-core/src/java/net/sf/mud4j/effect/ Effect.java

[<mpu...@us...>]

Revision: 138
          http://mud4j.svn.sourceforge.net/mud4j/?rev=138&view=rev
Author:   mpurland
Date:     2007-06-13 20:28:41 -0700 (Wed, 13 Jun 2007)

Log Message:
-----------
Remove unused @param tags in javadoc.

Modified Paths:
--------------
    trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java

Modified: trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java
===================================================================
--- trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java	2007-06-14 03:27:57 UTC (rev 137)
+++ trunk/mud4j-core/src/java/net/sf/mud4j/effect/Effect.java	2007-06-14 03:28:41 UTC (rev 138)
@@ -27,7 +27,6 @@
     /**
      * Apply effect on the target.
      * 
-     * @param target Target object to apply effect on.
      * @throws EffectException in case of an apply failure.
      */
     public void apply() throws EffectException;
@@ -35,7 +34,6 @@
     /**
      * Undo the effect from the target.
      * 
-     * @param target Target object to remove effect from.
      * @throws EffectException in case of an undo failure.
      */
     public void undo() throws EffectException;


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