svn commit: r682359 - in /maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help: AbstractHelpMojo.java AllProfilesMojo.java

[vs...@apache.org]

Author: vsiveton
Date: Mon Aug  4 05:23:24 2008
New Revision: 682359

URL: http://svn.apache.org/viewvc?rev=682359&view=rev
Log:
o javadoc improvements

Modified:
    maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/AbstractHelpMojo.java
    maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/AllProfilesMojo.java

Modified: maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/AbstractHelpMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/AbstractHelpMojo.java?rev=682359&r1=682358&r2=682359&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/AbstractHelpMojo.java (original)
+++ maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/AbstractHelpMojo.java Mon Aug  4 05:23:24 2008
@@ -38,6 +38,7 @@
 {
     /**
      * Optional parameter to write the output of this help in a given file, instead of writing to the console.
+     * <br/>
      * <b>Note</b>: Could be a relative path.
      *
      * @parameter expression="${output}"

Modified: maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/AllProfilesMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/AllProfilesMojo.java?rev=682359&r1=682358&r2=682359&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/AllProfilesMojo.java (original)
+++ maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/AllProfilesMojo.java Mon Aug  4 05:23:24 2008
@@ -41,8 +41,8 @@
 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
 
 /**
- * Displays a list of available profiles under the current project. <p>
- *
+ * Displays a list of available profiles under the current project.
+ * <br/>
  * <b>Note</b>: this Mojo lists <b>all</b> profiles for a project. If a
  * profile comes up with a status <b>inactive</b> then there might be a need to
  * set profile activation switches/property. <p>
@@ -66,8 +66,7 @@
     private List projects;
 
     /**
-     * The current build session instance. This is used for plugin manager API
-     * calls.
+     * The current build session instance. This is used for plugin manager API calls.
      *
      * @parameter expression="${session}"
      * @required
@@ -75,12 +74,7 @@
      */
     private MavenSession session;
 
-    /**
-     * Lists details for all profiles discovered.
-     *
-     * @throws MojoExecutionException if there was a <em>unexpected</em> build error.
-     * @throws MojoFailureException if there was an <em>expected</em> error leading to build failure.
-     */
+    /** {@inheritDoc} */
     public void execute()
         throws MojoExecutionException, MojoFailureException
     {
@@ -182,11 +176,11 @@
     }
 
     /**
-     * Loads up external Profiles using <code>profiles.xml</code> (if any)
-     * located in the current project's <code>${basedir}</code>.
+     * Loads up external Profiles using <code>profiles.xml</code> (if any) located in the current
+     * project's <code>${basedir}</code>.
      *
      * @param profileManager ProfileManager instance to use to load profiles from external Profiles.
-     * @param projectDir location of the current project.
+     * @param projectDir location of the current project, could be null.
      * @throws ProfileActivationException, if there was an error loading profiles.
      */
     private void loadProjectExternalProfiles( ProfileManager profileManager, File projectDir )
@@ -235,10 +229,10 @@
     }
 
     /**
-     * Load profiles from pom.xml.
+     * Load profiles from <code>pom.xml</code>.
      *
-     * @param profilesManager
-     * @param projectDir
+     * @param profilesManager not null
+     * @param project could be null
      */
     private void loadProjectPomProfiles( ProfileManager profilesManager, MavenProject project )
     {
@@ -285,10 +279,10 @@
     }
 
     /**
-     * Load profiles from settings.xml.
+     * Load profiles from <code>settings.xml</code>.
      *
-     * @param profileManager
-     * @param settings
+     * @param profileManager not null
+     * @param settings could be null
      */
     private void loadSettingsProfiles( ProfileManager profileManager, Settings settings )
     {