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

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

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

Log Message:
-----------
Add javadoc comments for public methods.

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

Modified: trunk/mud4j-core/src/java/net/sf/mud4j/ability/AbilityException.java
===================================================================
--- trunk/mud4j-core/src/java/net/sf/mud4j/ability/AbilityException.java	2006-12-24 17:35:53 UTC (rev 48)
+++ trunk/mud4j-core/src/java/net/sf/mud4j/ability/AbilityException.java	2006-12-24 17:40:18 UTC (rev 49)
@@ -27,11 +27,24 @@
     // Ability that the exceptio occurred upon.
     private Ability ability;
     
+    /**
+     * Create an ability exception that can be tracked
+     * to a particular ability.
+     * 
+     * @param ability Ability that throwed the exception.
+     */
     public AbilityException(Ability ability) {
         super();
         this.ability = ability;
     }
     
+    /**
+     * Creates an ability exception that can be tracked
+     * to a particular ability with a message.
+     * 
+     * @param message Exception message for the exception.
+     * @param ability Ability that throwed the exception.
+     */
     public AbilityException(String message, Ability ability) {
         super(message);
         this.ability = ability;
@@ -39,6 +52,7 @@
     
     /**
      * Return the ability.
+     * @return Returns an ability for the exception.
      */
     public Ability getAbility() {
         return ability;


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