svn commit: r628965 - in /maven/plugin-tools/trunk/maven-plugin-tools-model/src/main/java/org/apache/maven/plugin/tools/model: PluginMetadataParseException.java PluginMetadataParser.java

[vsiveton]

Author: vsiveton
Date: Mon Feb 18 18:08:20 2008
New Revision: 628965

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

Modified:
    
maven/plugin-tools/trunk/maven-plugin-tools-model/src/main/java/org/apache/maven/plugin/tools/model/PluginMetadataParseException.java
    
maven/plugin-tools/trunk/maven-plugin-tools-model/src/main/java/org/apache/maven/plugin/tools/model/PluginMetadataParser.java

Modified: 
maven/plugin-tools/trunk/maven-plugin-tools-model/src/main/java/org/apache/maven/plugin/tools/model/PluginMetadataParseException.java
URL: 
http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-model/src/main/java/org/apache/maven/plugin/tools/model/PluginMetadataParseException.java?rev=628965&r1=628964&r2=628965&view=diff
==============================================================================
--- 
maven/plugin-tools/trunk/maven-plugin-tools-model/src/main/java/org/apache/maven/plugin/tools/model/PluginMetadataParseException.java
 (original)
+++ 
maven/plugin-tools/trunk/maven-plugin-tools-model/src/main/java/org/apache/maven/plugin/tools/model/PluginMetadataParseException.java
 Mon Feb 18 18:08:20 2008
@@ -21,16 +21,26 @@
 
 import java.io.File;
 
+/**
+ * Exception when plugin metadata parsing occurred.
+ *
+ * @version $Id$
+ */
 public class PluginMetadataParseException
     extends Exception
 {
-
-    static final long serialVersionUID = 1;
+    /** serialVersionUID */
+    static final long serialVersionUID = 4022348153707995574L;
 
     private final File metadataFile;
 
     private final String originalMessage;
 
+    /**
+     * @param metadataFile
+     * @param message
+     * @param cause
+     */
     public PluginMetadataParseException( File metadataFile, String message, 
Throwable cause )
     {
         super( "Error parsing file: " + metadataFile + ". Reason: " + message, 
cause );
@@ -39,6 +49,10 @@
         this.originalMessage = message;
     }
 
+    /**
+     * @param metadataFile
+     * @param message
+     */
     public PluginMetadataParseException( File metadataFile, String message )
     {
         super( "Error parsing file: " + metadataFile + ". Reason: " + message 
);
@@ -47,14 +61,19 @@
         this.originalMessage = message;
     }
 
+    /**
+     * @return the metadata file
+     */
     public File getMetadataFile()
     {
         return metadataFile;
     }
 
+    /**
+     * @return the original message
+     */
     public String getOriginalMessage()
     {
         return originalMessage;
     }
-
 }

Modified: 
maven/plugin-tools/trunk/maven-plugin-tools-model/src/main/java/org/apache/maven/plugin/tools/model/PluginMetadataParser.java
URL: 
http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-model/src/main/java/org/apache/maven/plugin/tools/model/PluginMetadataParser.java?rev=628965&r1=628964&r2=628965&view=diff
==============================================================================
--- 
maven/plugin-tools/trunk/maven-plugin-tools-model/src/main/java/org/apache/maven/plugin/tools/model/PluginMetadataParser.java
 (original)
+++ 
maven/plugin-tools/trunk/maven-plugin-tools-model/src/main/java/org/apache/maven/plugin/tools/model/PluginMetadataParser.java
 Mon Feb 18 18:08:20 2008
@@ -37,10 +37,20 @@
 import java.util.List;
 import java.util.Set;
 
+/**
+ * Parser for plugin metadata.
+ *
+ * @version $Id$
+ */
 public class PluginMetadataParser
 {
     public static final String IMPL_BASE_PLACEHOLDER = 
"<REPLACE-WITH-MOJO-PATH>";
 
+    /**
+     * @param metadataFile the metadata file to be parse
+     * @return a set of <code>MojoDescriptor</code>
+     * @throws PluginMetadataParseException if any
+     */
     public Set parseMojoDescriptors( File metadataFile )
         throws PluginMetadataParseException
     {
@@ -179,5 +189,4 @@
 
         return descriptor;
     }
-
 }