svn commit: r641572 - in /myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder: BuildMetaDataMojo.java IOUtils.java ModelBuilder.java

[sk...@apache.org]

Author: skitching
Date: Wed Mar 26 13:59:39 2008
New Revision: 641572

URL: http://svn.apache.org/viewvc?rev=641572&view=rev
Log:
Improve comments

Modified:
    myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/BuildMetaDataMojo.java
    myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/IOUtils.java
    myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/ModelBuilder.java

Modified: myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/BuildMetaDataMojo.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/BuildMetaDataMojo.java?rev=641572&r1=641571&r2=641572&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/BuildMetaDataMojo.java (original)
+++ myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/BuildMetaDataMojo.java Wed Mar 26 13:59:39 2008
@@ -29,7 +29,11 @@
 import org.apache.myfaces.buildtools.maven2.plugin.builder.qdox.QdoxModelBuilder;
 
 /**
- * Creates myfaces-metadata.xml file.
+ * Maven goal which runs one or more ModelBuilder objects to gather metadata
+ * about JSF artifacts into a Model object, then save that model object as an
+ * xml file for use by other goals of this plugin.
+ * <p>
+ * By default, the generated file is named "META-INF/myfaces-metadata.xml".
  * 
  * @requiresDependencyResolution compile
  * @goal build-metadata
@@ -40,17 +44,23 @@
     final Log log = LogFactory.getLog(BuildMetaDataMojo.class.getName());
 
     /**
+     * Injected Maven project object.
+     * 
      * @parameter expression="${project}"
      * @readonly
      */
     private MavenProject project;
 
     /**
+     * Injected build directory for all generated stuff.
+     * 
      * @parameter expression="${project.build.directory}"
      */
     private File targetDirectory;
 
     /**
+     * Injected name of file to generate, relative to targetDirectory.
+     * 
      * @parameter
      */
     private String outputFile = "classes/META-INF/myfaces-metadata.xml";

Modified: myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/IOUtils.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/IOUtils.java?rev=641572&r1=641571&r2=641572&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/IOUtils.java (original)
+++ myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/IOUtils.java Wed Mar 26 13:59:39 2008
@@ -34,6 +34,7 @@
 import org.xml.sax.SAXException;
 
 /**
+ * Utilities to write a Model as xml, and read a Model in from xml.
  */
 public class IOUtils
 {

Modified: myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/ModelBuilder.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/ModelBuilder.java?rev=641572&r1=641571&r2=641572&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/ModelBuilder.java (original)
+++ myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/ModelBuilder.java Wed Mar 26 13:59:39 2008
@@ -4,8 +4,25 @@
 import org.apache.maven.project.MavenProject;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.model.Model;
 
+/**
+ * An interface that is implemented by classes that are capable of collecting
+ * metadata about JSF components, converters, validators, etc.
+ * <p>
+ * A ModelBuilder implementation might read xml files, or scan source code for
+ * annotations, or read data from a database, or any number of possible
+ * approaches. All that matters is that it makes a series of calls to a Model
+ * object to add information.
+ * <p>
+ * ModelBuilder implementations may be run as a chain, ie one instance used to
+ * populate the Model object with some objects, then a second instance used to
+ * add more data or modify the data already in the model.
+ */
 public interface ModelBuilder
 {
+    /**
+     * Given a model (which might already be partly populated with data, add
+     * information about JSF artifacts.
+     */
     public void buildModel(Model model, MavenProject project)
             throws MojoExecutionException;