Repository: commons-release-plugin
Updated Branches:
  refs/heads/master ed97df804 -> 21e282ae6


COMMONSSITE-99: Checkstyle javadoc errors, package-info.java


Project: http://git-wip-us.apache.org/repos/asf/commons-release-plugin/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-release-plugin/commit/21e282ae
Tree: 
http://git-wip-us.apache.org/repos/asf/commons-release-plugin/tree/21e282ae
Diff: 
http://git-wip-us.apache.org/repos/asf/commons-release-plugin/diff/21e282ae

Branch: refs/heads/master
Commit: 21e282ae64c28d1ffdd5d00c93f34bfd932db58e
Parents: ed97df8
Author: Rob Tompkins <chtom...@gmail.com>
Authored: Tue Jan 9 10:36:50 2018 -0500
Committer: Rob Tompkins <chtom...@gmail.com>
Committed: Tue Jan 9 10:36:50 2018 -0500

----------------------------------------------------------------------
 .../commons/release/plugin/mojos/package-info.java    | 14 +++++++++++++-
 .../apache/commons/release/plugin/package-info.java   | 13 ++++++++++++-
 .../commons/release/plugin/mojos/package-info.java    |  8 +++++++-
 .../apache/commons/release/plugin/package-info.java   |  2 +-
 .../commons/release/plugin/stubs/package-info.java    |  2 +-
 5 files changed, 34 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/21e282ae/src/main/java/org/apache/commons/release/plugin/mojos/package-info.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/release/plugin/mojos/package-info.java 
b/src/main/java/org/apache/commons/release/plugin/mojos/package-info.java
index 32828f0..6c463a2 100644
--- a/src/main/java/org/apache/commons/release/plugin/mojos/package-info.java
+++ b/src/main/java/org/apache/commons/release/plugin/mojos/package-info.java
@@ -14,4 +14,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.commons.release.plugin.mojos;
\ No newline at end of file
+/**
+ * This package contains all of the maven mojos for the 
commons-release-plugin. Currently
+ * this only has the following mojos:
+ * <ul>
+ *     <li>{@link 
org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo},</li>
+ *     <li>{@link 
org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo}, 
and</li>
+ *     <li>{@link 
org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo}</li>
+ * </ul>
+ *
+ * @author chtompki
+ * @since 1.0
+ */
+package org.apache.commons.release.plugin.mojos;

http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/21e282ae/src/main/java/org/apache/commons/release/plugin/package-info.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/release/plugin/package-info.java 
b/src/main/java/org/apache/commons/release/plugin/package-info.java
index 4852740..0dd83a5 100644
--- a/src/main/java/org/apache/commons/release/plugin/package-info.java
+++ b/src/main/java/org/apache/commons/release/plugin/package-info.java
@@ -14,4 +14,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.commons.release.plugin;
\ No newline at end of file
+/**
+ * Base package for the commons-release-plugin. It should contain only classes
+ * that are used across all sub-packages. For now the only class in this 
package
+ * is:
+ * <ul>
+ *     <li>{@link org.apache.commons.release.plugin.SharedFunctions}</li>
+ * </ul>
+ *
+ * @author chtompki
+ * @since 1.0
+ */
+package org.apache.commons.release.plugin;

http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/21e282ae/src/test/java/org/apache/commons/release/plugin/mojos/package-info.java
----------------------------------------------------------------------
diff --git 
a/src/test/java/org/apache/commons/release/plugin/mojos/package-info.java 
b/src/test/java/org/apache/commons/release/plugin/mojos/package-info.java
index c9ab4b7..9a126a6 100644
--- a/src/test/java/org/apache/commons/release/plugin/mojos/package-info.java
+++ b/src/test/java/org/apache/commons/release/plugin/mojos/package-info.java
@@ -21,4 +21,10 @@
  * @author chtompki
  * @since 1.0
  */
-package org.apache.commons.release.plugin.mojos;
\ No newline at end of file
+/**
+ * Unit tests for all of the mojos of the project.
+ *
+ * @author chtompki
+ * @since 1.0
+ */
+package org.apache.commons.release.plugin.mojos;

http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/21e282ae/src/test/java/org/apache/commons/release/plugin/package-info.java
----------------------------------------------------------------------
diff --git a/src/test/java/org/apache/commons/release/plugin/package-info.java 
b/src/test/java/org/apache/commons/release/plugin/package-info.java
index 8c9e5ff..6733c3a 100644
--- a/src/test/java/org/apache/commons/release/plugin/package-info.java
+++ b/src/test/java/org/apache/commons/release/plugin/package-info.java
@@ -21,4 +21,4 @@
  * @author chtompki
  * @since 1.0
  */
-package org.apache.commons.release.plugin;
\ No newline at end of file
+package org.apache.commons.release.plugin;

http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/21e282ae/src/test/java/org/apache/commons/release/plugin/stubs/package-info.java
----------------------------------------------------------------------
diff --git 
a/src/test/java/org/apache/commons/release/plugin/stubs/package-info.java 
b/src/test/java/org/apache/commons/release/plugin/stubs/package-info.java
index b0a334f..9914ceb 100644
--- a/src/test/java/org/apache/commons/release/plugin/stubs/package-info.java
+++ b/src/test/java/org/apache/commons/release/plugin/stubs/package-info.java
@@ -24,4 +24,4 @@
  * @author chtompki
  * @since 1.0
  */
-package org.apache.commons.release.plugin.stubs;
\ No newline at end of file
+package org.apache.commons.release.plugin.stubs;

Reply via email to