DPML Notify

[mcconnell at BerliOS <mcconnell AT mail.berlios.de>]

Author: mcconnell
Date: 2006-03-18 17:18:57 +0100 (Sat, 18 Mar 2006)
New Revision: 1215

Modified:
   
trunk/main/depot/library/src/main/net/dpml/library/info/LibraryDirective.java
   trunk/main/depot/library/src/main/net/dpml/library/info/TypeDirective.java
   trunk/main/metro/model/src/main/net/dpml/metro/data/ComponentDirective.java
   trunk/main/metro/model/src/main/net/dpml/metro/data/LookupDirective.java
   
trunk/main/metro/runtime/src/main/net/dpml/metro/runtime/CompositionController.java
   trunk/main/metro/state/impl/src/main/net/dpml/state/impl/DefaultState.java
   trunk/main/metro/state/impl/src/main/net/dpml/state/impl/StateWriter.java
   
trunk/main/metro/tools/src/main/net/dpml/metro/tools/CategoriesDescriptorDataType.java
   
trunk/main/metro/tools/src/main/net/dpml/metro/tools/ComponentBuilderTask.java
   trunk/main/metro/tools/src/main/net/dpml/metro/tools/EntryDataType.java
   
trunk/main/station/builder/src/main/net/dpml/station/builder/RegistryWriter.java
   trunk/main/transit/core/src/main/net/dpml/part/PartHandler.java
   trunk/main/transit/core/src/main/net/dpml/part/StandardPartHandler.java
   trunk/main/transit/core/src/main/net/dpml/part/Strategy.java
   trunk/main/transit/core/src/main/net/dpml/transit/Repository.java
Log:
resolve all javadoc related warnings

Modified: 
trunk/main/depot/library/src/main/net/dpml/library/info/LibraryDirective.java
===================================================================
--- 
trunk/main/depot/library/src/main/net/dpml/library/info/LibraryDirective.java 
      2006-03-18 15:46:02 UTC (rev 1214)
+++ 
trunk/main/depot/library/src/main/net/dpml/library/info/LibraryDirective.java 
      2006-03-18 16:18:57 UTC (rev 1215)
@@ -36,7 +36,7 @@
    /**
     * Creation of a new library directive.
     * @param imports module imports
-    * @param modules the set of declared modules
+    * @param resources the set of declared resources
     * @param properties library properties
     */
     public LibraryDirective(
@@ -82,7 +82,7 @@
     
    /**
     * Return the set of module directives.
-    * @return the module directive array
+    * @return the resource directive array
     */
     public ResourceDirective[] getResourceDirectives()
     {
@@ -115,8 +115,8 @@
     }
     
    /**
-    * Compute the hash value.
-    * @return the hascode value
+    * Compute the hashcode value.
+    * @return the hash value
     */
     public int hashCode()
     {

Modified: 
trunk/main/depot/library/src/main/net/dpml/library/info/TypeDirective.java
===================================================================
--- 
trunk/main/depot/library/src/main/net/dpml/library/info/TypeDirective.java  
2006-03-18 15:46:02 UTC (rev 1214)
+++ 
trunk/main/depot/library/src/main/net/dpml/library/info/TypeDirective.java  
2006-03-18 16:18:57 UTC (rev 1215)
@@ -81,7 +81,7 @@
     * Creation of a new type directive.
     * @param name the name
     * @param alias alias production policy
-    * @param properties supplimentary properties
+    * @param element DOM element defining the type 
     */
     public TypeDirective( String name, boolean alias, Element element )
     {

Modified: 
trunk/main/metro/model/src/main/net/dpml/metro/data/ComponentDirective.java
===================================================================
--- 
trunk/main/metro/model/src/main/net/dpml/metro/data/ComponentDirective.java 
2006-03-18 15:46:02 UTC (rev 1214)
+++ 
trunk/main/metro/model/src/main/net/dpml/metro/data/ComponentDirective.java 
2006-03-18 16:18:57 UTC (rev 1215)
@@ -200,7 +200,6 @@
     * @param context context directive
     * @param parameters the default parameters
     * @param config the default configuration
-    * @param classloader the component classloader directive
     * @param parts the component internal parts
     */
     public ComponentDirective(

Modified: 
trunk/main/metro/model/src/main/net/dpml/metro/data/LookupDirective.java
===================================================================
--- trunk/main/metro/model/src/main/net/dpml/metro/data/LookupDirective.java  
  2006-03-18 15:46:02 UTC (rev 1214)
+++ trunk/main/metro/model/src/main/net/dpml/metro/data/LookupDirective.java  
  2006-03-18 16:18:57 UTC (rev 1215)
@@ -43,8 +43,8 @@
 
     /**
      * Creation of a new lookup directive.
-     * @param spec the lookup reference
-     * @exception NullPointerException if the uri argument is null.
+     * @param classname the service classname
+     * @exception NullPointerException if the classname argument is null.
      */
     public LookupDirective( final String classname )
         throws NullPointerException

Modified: 
trunk/main/metro/runtime/src/main/net/dpml/metro/runtime/CompositionController.java
===================================================================
--- 
trunk/main/metro/runtime/src/main/net/dpml/metro/runtime/CompositionController.java
 2006-03-18 15:46:02 UTC (rev 1214)
+++ 
trunk/main/metro/runtime/src/main/net/dpml/metro/runtime/CompositionController.java
 2006-03-18 16:18:57 UTC (rev 1215)
@@ -148,7 +148,8 @@
 
    /**
     * Instantiate a value.
-    * @param classloader the implementation classloader established for the 
part
+    * @param anchor the anchor classloader
+    * @param classpath the part classpath definition
     * @param data the part deployment data
     * @param args supplimentary arguments
     * @exception Exception if a deployment error occurs

Modified: 
trunk/main/metro/state/impl/src/main/net/dpml/state/impl/DefaultState.java
===================================================================
--- 
trunk/main/metro/state/impl/src/main/net/dpml/state/impl/DefaultState.java  
2006-03-18 15:46:02 UTC (rev 1214)
+++ 
trunk/main/metro/state/impl/src/main/net/dpml/state/impl/DefaultState.java  
2006-03-18 16:18:57 UTC (rev 1215)
@@ -48,7 +48,6 @@
 
    /**
     * Creation of a new state.
-    * @param name the state name
     */
     public DefaultState()
     {

Modified: 
trunk/main/metro/state/impl/src/main/net/dpml/state/impl/StateWriter.java
===================================================================
--- trunk/main/metro/state/impl/src/main/net/dpml/state/impl/StateWriter.java 
  2006-03-18 15:46:02 UTC (rev 1214)
+++ trunk/main/metro/state/impl/src/main/net/dpml/state/impl/StateWriter.java 
  2006-03-18 16:18:57 UTC (rev 1215)
@@ -65,7 +65,7 @@
     
    /**
     * Externalize the part to XML.
-    * @param part the part to externalize
+    * @param state the state graph to externalize
     * @param output the output stream 
     * @exception IOException if an IO error occurs
     */

Modified: 
trunk/main/metro/tools/src/main/net/dpml/metro/tools/CategoriesDescriptorDataType.java
===================================================================
--- 
trunk/main/metro/tools/src/main/net/dpml/metro/tools/CategoriesDescriptorDataType.java
      2006-03-18 15:46:02 UTC (rev 1214)
+++ 
trunk/main/metro/tools/src/main/net/dpml/metro/tools/CategoriesDescriptorDataType.java
      2006-03-18 16:18:57 UTC (rev 1215)
@@ -61,6 +61,9 @@
         return categories;
     }
 
+   /**
+    * Description of a single logging category.
+    */
     public class CategoryDescriptorDataType
     {
         private String m_name;
@@ -68,7 +71,7 @@
     
        /**
         * Set the service classname.
-        * @param classname the name of the service interface class
+        * @param name the name of the service interface class
         */
         public void setName( final String name )
         {

Modified: 
trunk/main/metro/tools/src/main/net/dpml/metro/tools/ComponentBuilderTask.java
===================================================================
--- 
trunk/main/metro/tools/src/main/net/dpml/metro/tools/ComponentBuilderTask.java
      2006-03-18 15:46:02 UTC (rev 1214)
+++ 
trunk/main/metro/tools/src/main/net/dpml/metro/tools/ComponentBuilderTask.java
      2006-03-18 16:18:57 UTC (rev 1215)
@@ -277,10 +277,8 @@
     }
 
    /**
-    * Create a component directive.
+    * Create a component strategy.
     * @param classloader the classloader
-    * @param cld the classloader directive
-    * @param file the output file
     * @return the component directive
     */
     public Strategy createStrategy( ClassLoader classloader )

Modified: 
trunk/main/metro/tools/src/main/net/dpml/metro/tools/EntryDataType.java
===================================================================
--- trunk/main/metro/tools/src/main/net/dpml/metro/tools/EntryDataType.java   
  2006-03-18 15:46:02 UTC (rev 1214)
+++ trunk/main/metro/tools/src/main/net/dpml/metro/tools/EntryDataType.java   
  2006-03-18 16:18:57 UTC (rev 1215)
@@ -58,8 +58,8 @@
     }
 
    /**
-    * Set the uri that this directive references.
-    * @param uri the uri
+    * Set the lookup attribute value.
+    * @param spec the service classname
     */
     public void setLookup( final String spec )
     {

Modified: 
trunk/main/station/builder/src/main/net/dpml/station/builder/RegistryWriter.java
===================================================================
--- 
trunk/main/station/builder/src/main/net/dpml/station/builder/RegistryWriter.java
    2006-03-18 15:46:02 UTC (rev 1214)
+++ 
trunk/main/station/builder/src/main/net/dpml/station/builder/RegistryWriter.java
    2006-03-18 16:18:57 UTC (rev 1215)
@@ -56,8 +56,9 @@
     
    /**
     * Externalize the part to XML.
-    * @param part the part to externalize
+    * @param descriptor the registry descriptor
     * @param output the output stream 
+    * @param pad offset padding to be applied when writing data to the stream
     * @exception IOException if an IO error occurs
     */
     public void writeRegistryDescriptor( 

Modified: trunk/main/transit/core/src/main/net/dpml/part/PartHandler.java
===================================================================
--- trunk/main/transit/core/src/main/net/dpml/part/PartHandler.java     
2006-03-18 15:46:02 UTC (rev 1214)
+++ trunk/main/transit/core/src/main/net/dpml/part/PartHandler.java     
2006-03-18 16:18:57 UTC (rev 1215)
@@ -39,7 +39,8 @@
 
    /**
     * Instantiate a value.
-    * @param classloader the implementation classloader established for the 
part
+    * @param anchor the anchor classloader
+    * @param classpath the part classpath
     * @param data the part deployment data
     * @param args supplimentary arguments
     * @exception Exception if a deployment error occurs

Modified: 
trunk/main/transit/core/src/main/net/dpml/part/StandardPartHandler.java
===================================================================
--- trunk/main/transit/core/src/main/net/dpml/part/StandardPartHandler.java   
  2006-03-18 15:46:02 UTC (rev 1214)
+++ trunk/main/transit/core/src/main/net/dpml/part/StandardPartHandler.java   
  2006-03-18 16:18:57 UTC (rev 1215)
@@ -50,7 +50,8 @@
     
    /**
     * Instantiate a value.
-    * @param classloader the implementation classloader established for the 
part
+    * @param anchor the anchor classloader
+    * @param classpath the part classpath
     * @param data the part deployment data
     * @param args supplimentary arguments
     * @exception Exception if a deployment error occurs

Modified: trunk/main/transit/core/src/main/net/dpml/part/Strategy.java
===================================================================
--- trunk/main/transit/core/src/main/net/dpml/part/Strategy.java        
2006-03-18 15:46:02 UTC (rev 1214)
+++ trunk/main/transit/core/src/main/net/dpml/part/Strategy.java        
2006-03-18 16:18:57 UTC (rev 1215)
@@ -36,7 +36,7 @@
     
    /**
     * Creation of a new part instantiation strategy.
-    * @param namespace the strategy namespace
+    * @param builder the builder uri
     * @param controller the runtime controller that will handle part 
deployment
     * @param data the data to tbe supplied to the controller
     */ 
@@ -47,9 +47,10 @@
     
    /**
     * Creation of a new part instantiation strategy.
-    * @param namespace the strategy namespace
+    * @param builder the builder uri
     * @param controller the runtime controller that will handle part 
deployment
     * @param data the data to tbe supplied to the controller
+    * @param alias the alias flag
     */ 
     public Strategy( URI builder, PartDirective controller, Serializable 
data, boolean alias )
     {

Modified: trunk/main/transit/core/src/main/net/dpml/transit/Repository.java
===================================================================
--- trunk/main/transit/core/src/main/net/dpml/transit/Repository.java   
2006-03-18 15:46:02 UTC (rev 1214)
+++ trunk/main/transit/core/src/main/net/dpml/transit/Repository.java   
2006-03-18 16:18:57 UTC (rev 1215)
@@ -47,21 +47,21 @@
     Part getPart( URI uri ) throws IOException;
 
    /**
-    * Get a plugin classloader relative to a supplied uri.
+    * Get a part classloader relative to a supplied uri.
     *
     * @param parent the parent classloader
-    * @param uri the plugin uri
-    * @return the plugin classloader
+    * @param part the part definition
+    * @return the classloader
     * @exception IOException if plugin loading exception occurs
     */
     ClassLoader getPluginClassLoader( ClassLoader parent, Part part )
         throws IOException;
         
    /**
-    * Get a plugin classloader relative to a supplied uri.
+    * Get a part classloader relative to a supplied uri.
     *
     * @param parent the parent classloader
-    * @param uri the plugin uri
+    * @param uri the part uri
     * @return the plugin classloader
     * @exception IOException if plugin loading exception occurs
     */
@@ -72,8 +72,8 @@
     * Get a plugin class relative to a supplied uri.
     *
     * @param parent the parent classloader
-    * @param uri the plugin uri
-    * @return the plugin class
+    * @param uri the part uri
+    * @return the part class
     * @exception IOException if plugin loading exception occurs
     */
     Class getPluginClass( ClassLoader parent, URI uri )
@@ -83,15 +83,15 @@
     * Get a plugin class relative to a supplied uri.
     *
     * @param parent the parent classloader
-    * @param uri the plugin uri
-    * @return the plugin class
+    * @param part the part definition
+    * @return the class
     * @exception IOException if plugin loading exception occurs
     */
     Class getPluginClass( ClassLoader parent, Part part )
         throws IOException;
 
    /**
-    * Creates a plugin from a uri reference.
+    * Creates an object from a uri reference.
     *
     * @param parent the parent classloader
     * @param uri the reference to the application