[mud4j-commit] SF.net SVN: mud4j: [81] trunk/mud4j-core/src/java/net/sf/mud4j/ability/ Ability.java

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

Revision: 81
          http://mud4j.svn.sourceforge.net/mud4j/?rev=81&view=rev
Author:   mpurland
Date:     2006-12-29 21:05:32 -0800 (Fri, 29 Dec 2006)

Log Message:
-----------
Update class and method javadoc comments.

Modified Paths:
--------------
    trunk/mud4j-core/src/java/net/sf/mud4j/ability/Ability.java

Modified: trunk/mud4j-core/src/java/net/sf/mud4j/ability/Ability.java
===================================================================
--- trunk/mud4j-core/src/java/net/sf/mud4j/ability/Ability.java	2006-12-30 05:04:35 UTC (rev 80)
+++ trunk/mud4j-core/src/java/net/sf/mud4j/ability/Ability.java	2006-12-30 05:05:32 UTC (rev 81)
@@ -17,20 +17,18 @@
 package net.sf.mud4j.ability;
 
 /**
- * Ability interface to create basic interface for abilities that
- * may be used by commands, or other abilities.
+ * Ability interface to create basic interface for abilities that may be used by
+ * commands, or other abilities. An ability is a runnable independent command
+ * that acts upon a target (Character, Location, Item, etc).
  * 
- * An ability is a runnable independent command that acts upon
- * a target (Character, Location, Item, etc).
- * 
  * @author Matthew Purland
  */
 public interface Ability {
     /**
-     * Run the ability.  Will throw an exception {@link AbilityException} if
-     * the ability encounters a problem, or if it cannot continue.
+     * Run the ability.
      * 
-     * @throws AbilityException
+     * @throws AbilityException in case the ability encounters a problem or
+     *             cannot continue.
      */
     public void run() throws AbilityException;
 }


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