Adding documentation, to resolve MNG-1082.

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@315045 13f79535-47bb-0310-9956-ffa450edef68

maven-plugins/maven-projecthelp-plugin/src/main/java/org/apache/maven/plugins/projecthelp/EffectivePomPlugin.java

@@ -40,6 +40,9 @@ public class EffectivePomPlugin
 {
 
     /**
+     * The projects in the current build. The effective-POM for
+     * each of these projects will written.
+     * 
      * @parameter expression="${reactorProjects}"
      * @required
      * @readonly
@@ -47,6 +50,8 @@ public class EffectivePomPlugin
     private List projects;
 
     /**
+     * If specified, write the output to this path.
+     * 
      * @parameter expression="${output}"
      */
     private File output;

maven-plugins/maven-projecthelp-plugin/src/main/java/org/apache/maven/plugins/projecthelp/EffectiveSettingsMojo.java

@@ -37,6 +37,9 @@ public class EffectiveSettingsMojo
 {
 
     /**
+     * The system settings for Maven. This is the instance resulting from 
+     * merging global- and user-level settings files.
+     * 
      * @parameter expression="${settings}"
      * @readonly
      * @required
@@ -44,7 +47,9 @@ public class EffectiveSettingsMojo
     private Settings settings;
 
     /**
-     * @parameter
+     * If specified write the effective settings file out to this path.
+     * 
+     * @parameter expression="${output}"
      */
     private String output;
 
@@ -115,22 +120,12 @@ public class EffectiveSettingsMojo
         }
     }
 
-    protected final String getOutput()
+    public final void setOutput( String output )
-    {
-        return output;
-    }
-
-    protected final void setOutput( String output )
     {
         this.output = output;
     }
 
-    protected final Settings getSettings()
+    public final void setSettings( Settings settings )
-    {
-        return settings;
-    }
-
-    protected final void setSettings( Settings settings )
     {
         this.settings = settings;
     }