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

Author: mcconnell
Date: Tue Jul  6 15:53:18 2004
New Revision: 22643

Modified:
   avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Definition.java
   avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/ElementHelper.java
   avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Home.java
   avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Info.java
Log:
more doc updates

Modified: avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Definition.java
==============================================================================
--- avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Definition.java	(original)
+++ avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Definition.java	Tue Jul  6 15:53:18 2004
@@ -46,7 +46,7 @@
     * @param path the basedir as a relative path
     * @param info a descriptor of the name, grolup, version and delivery status
     * @param gump addition gump idiosyncracies
-    * @param resource the set of resource dependencies
+    * @param resources the set of resource dependencies
     * @param plugins the set of plugin dependencies
     */
     public Definition( 

Modified: avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/ElementHelper.java
==============================================================================
--- avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/ElementHelper.java	(original)
+++ avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/ElementHelper.java	Tue Jul  6 15:53:18 2004
@@ -43,7 +43,7 @@
 {
    /**
     * Return the root element of the supplied file.
-    * @para definition the file to load
+    * @param definition the file to load
     * @exception BuildException if the error occurs during root element establishment
     */
     public static Element getRootElement( final File definition )
@@ -96,7 +96,7 @@
 
    /**
     * Return the root element of the supplied input stream.
-    * @para input the input stream containing a XML definition
+    * @param input the input stream containing a XML definition
     * @exception BuildException if the error occurs during root element establishment
     */
     public static Element getRootElement( final InputStream input )

Modified: avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Home.java
==============================================================================
--- avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Home.java	(original)
+++ avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Home.java	Tue Jul  6 15:53:18 2004
@@ -78,7 +78,7 @@
    /**
     * Creation of a new home using a supplied index.
     * @param project the ant project establishing the home
-    * @param magic the magic system instance
+    * @param system the magic system instance
     * @param index the magic project index
     */
     protected Home( Project project, Magic system, File index )

Modified: avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Info.java
==============================================================================
--- avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Info.java	(original)
+++ avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/model/Info.java	Tue Jul  6 15:53:18 2004
@@ -224,7 +224,8 @@
     }
 
    /**
-    * Return the path to the artifact in the form [group]/[type]s/[filename].
+    * Return the path to the artifact.  The path is returned in the 
+    * form [group]/[type]s/[filename].
     * @return the artifact relative path
     */
     public String getPath()
@@ -239,7 +240,7 @@
     }
 
    /**
-    * Return the artifact uri in the form "artifact:[type]:[spec].
+    * Return the artifact uri. The path is returned in the form "artifact:[type]:[spec].
     * @return the artifact uri
     */
     public String getURI()
@@ -253,7 +254,8 @@
     }
 
    /**
-    * Return the artifact specification in the form [group]/[name]#[version].
+    * Return the artifact specification. The path is retured in the form 
+    * [group]/[name]#[version].
     * @return the artifact spec
     */
     public String getSpec()