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

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

Revision: 50
          http://mud4j.svn.sourceforge.net/mud4j/?rev=50&view=rev
Author:   mpurland
Date:     2006-12-24 09:45:00 -0800 (Sun, 24 Dec 2006)

Log Message:
-----------
Update javadoc comments.

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

Modified: trunk/mud4j-core/src/java/net/sf/mud4j/effect/EffectBehavior.java
===================================================================
--- trunk/mud4j-core/src/java/net/sf/mud4j/effect/EffectBehavior.java	2006-12-24 17:40:18 UTC (rev 49)
+++ trunk/mud4j-core/src/java/net/sf/mud4j/effect/EffectBehavior.java	2006-12-24 17:45:00 UTC (rev 50)
@@ -30,16 +30,24 @@
     
     /**
      * Get list of effects.
+     * 
+     * @return Returns a list of effects.
      */
     public List<Effect> getEffects();
     
     /**
      * Add effect to behavior object.
+     * 
+     * @param effect Effect to add.
+     * @throws EffectException in case adding an effect will not be possible.
      */
     public void addEffect(Effect effect) throws EffectException;
     
     /**
      * Remove effect from behavior object.
+     * 
+     * @param effect Effect to remove.
+     * @throws EffectException in case removing an effect will not be possible.
      */
     public void removeEffect(Effect effect) throws EffectException;
     


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