[maven-help-plugin] 24/37: Adding documentation, to resolve MNG-1082.

[hb...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hboutemy pushed a commit to annotated tag maven-help-plugin-2.0
in repository https://gitbox.apache.org/repos/asf/maven-help-plugin.git

commit 1d13ef53b41a45aebf5b2ba1e09a3f8d1d4c47ae
Author: John Dennis Casey <jd...@apache.org>
AuthorDate: Wed Oct 12 20:58:36 2005 +0000

    Adding documentation, to resolve MNG-1082.
    
    git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk/maven-plugins/maven-projecthelp-plugin@315045 13f79535-47bb-0310-9956-ffa450edef68
---
 .../plugins/projecthelp/EffectivePomPlugin.java     |  5 +++++
 .../plugins/projecthelp/EffectiveSettingsMojo.java  | 21 ++++++++-------------
 2 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/src/main/java/org/apache/maven/plugins/projecthelp/EffectivePomPlugin.java b/src/main/java/org/apache/maven/plugins/projecthelp/EffectivePomPlugin.java
index 5cab84c..f5ed1e3 100644
--- a/src/main/java/org/apache/maven/plugins/projecthelp/EffectivePomPlugin.java
+++ b/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;
diff --git a/src/main/java/org/apache/maven/plugins/projecthelp/EffectiveSettingsMojo.java b/src/main/java/org/apache/maven/plugins/projecthelp/EffectiveSettingsMojo.java
index ef8d2e6..5d2a6d2 100644
--- a/src/main/java/org/apache/maven/plugins/projecthelp/EffectiveSettingsMojo.java
+++ b/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()
-    {
-        return output;
-    }
-
-    protected final void setOutput( String output )
+    public final void setOutput( String output )
     {
         this.output = output;
     }
 
-    protected final Settings getSettings()
-    {
-        return settings;
-    }
-
-    protected final void setSettings( Settings settings )
+    public final void setSettings( Settings settings )
     {
         this.settings = settings;
     }

-- 
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.