svn commit: rev 22627 - avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model

Author: mcconnell
Date: Tue Jul  6 06:49:15 2004
New Revision: 22627

Modified:
   avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Gump.java
Log:
javadoc

Modified: avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Gump.java
==============================================================================
--- avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Gump.java	(original)
+++ avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Gump.java	Tue Jul  6 06:49:15 2004
@@ -20,7 +20,8 @@
 import org.apache.tools.ant.BuildException;
 
 /**
- * Project info.
+ * An immutable data object holding supplimentary information required for
+ * the creation fo gump project defintions.
  *
  * @author <a href="mailto:[email protected]">Avalon Development Team</a>
  * @version $Revision: 1.2 $ $Date: 2004/03/17 10:30:09 $
@@ -34,6 +35,16 @@
     private boolean m_ignore;
     private boolean m_classpath;
 
+   /**
+    * Creation of a new gump supplementation definition.
+    * @param alias a name used by gump when referring to a magic key
+    * @param id a buuild id used by gump when referencing projects that declare 
+    *    multiple jar file deliverables
+    * @param classpath if TRUE then the defintion to which this object is associated will
+    *   referenced as a gump classpath reference
+    * @param ignore if TRUE magic can ignore this project when generating a gump project 
+    *   descriptor
+    */
     public Gump( final String alias, final String id, boolean classpath, boolean ignore )
     {
         m_alias = alias;
@@ -44,6 +55,7 @@
 
    /**
     * Gump alias name.
+    * @return the alias name
     */
     public String getAlias()
     {
@@ -51,7 +63,8 @@
     }
 
    /**
-    * Gump project artifact id.
+    * Gump project jar id.
+    * @return the gump jar id
     */
     public String getId()
     {
@@ -61,6 +74,7 @@
    /**
     * Return true if this defintion can be ignored when 
     * building a gump project dependency.
+    * @return the ignorable status
     */
     public boolean isIgnorable()
     {
@@ -70,6 +84,7 @@
    /**
     * Return true if this defintion is required as part of the 
     * classpath established by gump.
+    * @return TRUE if this is a classpath entry
     */
     public boolean isClasspathEntry()
     {