svn commit: r662224 - in /activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven: ConvertersMojo.java DotMojo.java EmbeddedMojo.java RunMojo.java

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

svn commit: r662224 - in /activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven: ConvertersMojo.java DotMojo.java EmbeddedMojo.java RunMojo.java

davsclaus-2
Author: davsclaus
Date: Sun Jun  1 07:39:06 2008
New Revision: 662224

URL: http://svn.apache.org/viewvc?rev=662224&view=rev
Log:
javadoc polished

Modified:
    activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/ConvertersMojo.java
    activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/DotMojo.java
    activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/EmbeddedMojo.java
    activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/RunMojo.java

Modified: activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/ConvertersMojo.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/ConvertersMojo.java?rev=662224&r1=662223&r2=662224&view=diff
==============================================================================
--- activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/ConvertersMojo.java (original)
+++ activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/ConvertersMojo.java Sun Jun  1 07:39:06 2008
@@ -105,6 +105,7 @@
      * @component
      */
     protected ArtifactFactory artifactFactory;
+
     /**
      * Base output directory for reports.
      *
@@ -130,13 +131,10 @@
      */
     private Renderer renderer;
 
-
-
     /**
      * Gets resource bundle for given locale.
      *
-     * @param locale
-     *            locale
+     * @param locale    locale
      * @return resource bundle
      */
     protected ResourceBundle getBundle(final Locale locale) {
@@ -161,9 +159,6 @@
         return getBundle(locale).getString("report.converters.name");
     }
 
-    /**
-     * @see org.apache.maven.reporting.MavenReport#getOutputName()
-     */
     public String getOutputName() {
         return "camel-converters";
     }
@@ -183,9 +178,6 @@
         return renderer;
     }
 
-    /**
-     * @see org.apache.maven.reporting.AbstractMavenReport#execute()
-     */
     public void execute() throws MojoExecutionException {
         if (!canGenerateReport()) {
             return;
@@ -227,9 +219,6 @@
         }
     }
 
-    /**
-     * @see org.apache.maven.reporting.AbstractMavenReport#execute()
-     */
     @Override
     protected void executeReport(Locale locale) throws MavenReportException {
 

Modified: activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/DotMojo.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/DotMojo.java?rev=662224&r1=662223&r2=662224&view=diff
==============================================================================
--- activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/DotMojo.java (original)
+++ activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/DotMojo.java Sun Jun  1 07:39:06 2008
@@ -67,11 +67,13 @@
     //
     /**
      * The duration to run the application for which by default is in
-     * milliseconds.
+     * milliseconds. A value <= 0 will run forever.
+     * Adding a s indicates seconds - eg "5s" means 5 seconds.
      *
      * @parameter expression="2s"
      */
     protected String duration;
+
     /**
      * Whether we should boot up camel with the META-INF/services/*.xml to
      * generate the DOT file
@@ -79,6 +81,7 @@
      * @parameter expression="true"
      */
     protected boolean runCamel;
+
     /**
      * Should we try run the DOT executable on the generated .DOT file to
      * generate images
@@ -86,6 +89,7 @@
      * @parameter expression="true"
      */
     protected boolean useDot;
+
     /**
      * Reference to Maven 2 Project.
      *
@@ -94,6 +98,7 @@
      * @readonly
      */
     private MavenProject project;
+
     /**
      * Base output directory.
      *
@@ -101,6 +106,7 @@
      * @required
      */
     private File buildDirectory;
+
     /**
      * Base output directory for reports.
      *
@@ -108,6 +114,7 @@
      * @required
      */
     private File outputDirectory;
+
     /**
      * In the case of multiple camel contexts, setting aggregate == true will
      * aggregate all into a monolithic context, otherwise they will be processed
@@ -116,6 +123,7 @@
      * @parameter
      */
     private String aggregate;
+
     /**
      * GraphViz executable location; visualization (images) will be generated
      * only if you install this program and set this property to the executable
@@ -124,6 +132,7 @@
      * @parameter expression="dot"
      */
     private String executable;
+
     /**
      * Graphviz output types. Default is png. Possible values: png, jpg, gif,
      * svg.
@@ -131,12 +140,14 @@
      * @required
      */
     private String graphvizOutputType;
+
     /**
      * Graphviz output types. Possible values: png, jpg, gif, svg.
      *
      * @parameter
      */
     private String[] graphvizOutputTypes;
+
     /**
      * Doxia SiteRender.
      *
@@ -162,9 +173,6 @@
         return getBundle(locale).getString("report.dot.name");
     }
 
-    /**
-     * @see org.apache.maven.reporting.MavenReport#getOutputName()
-     */
     public String getOutputName() {
         return SUBDIRECTORY + "/index";
     }
@@ -185,9 +193,6 @@
         this.useDot = useDot;
     }
 
-    /**
-     * @see org.apache.maven.plugin.Mojo#execute()
-     */
     public void execute() throws MojoExecutionException {
         this.execute(this.buildDirectory, Locale.getDefault());
         try {
@@ -197,9 +202,6 @@
         }
     }
 
-    /**
-     * @see org.apache.maven.reporting.AbstractMavenReport#executeReport(Locale)
-     */
     protected void executeReport(final Locale locale) throws MavenReportException {
         try {
             this.execute(this.outputDirectory, locale);
@@ -509,9 +511,6 @@
         return this.renderer;
     }
 
-    /**
-     * @see org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()
-     */
     protected String getOutputDirectory() {
         return this.outputDirectory.getAbsolutePath();
     }

Modified: activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/EmbeddedMojo.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/EmbeddedMojo.java?rev=662224&r1=662223&r2=662224&view=diff
==============================================================================
--- activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/EmbeddedMojo.java (original)
+++ activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/EmbeddedMojo.java Sun Jun  1 07:39:06 2008
@@ -40,13 +40,17 @@
  * @execute phase="test-compile"
  */
 public class EmbeddedMojo extends AbstractExecMojo {
+
     /**
      * The duration to run the application for which by default is in milliseconds.
+     * A value <= 0 will run forever.
+     * Adding a s indicates seconds - eg "5s" means 5 seconds.
      *
      * @parameter expression="-1"
      * @readonly
      */
     protected String duration;
+    
     /**
      * The DOT File name used to generate the DOT diagram of the route definitions
      *
@@ -54,6 +58,7 @@
      * @readonly
      */
     protected String outputDirectory;
+    
     /**
      * Allows the DOT file generation to be disabled
      *
@@ -61,6 +66,7 @@
      * @readonly
      */
     protected boolean dotEnabled;
+    
     /**
      * Allows the routes from multiple contexts to be aggregated into one DOT file (in addition to the individual files)
      *
@@ -75,6 +81,7 @@
      * @parameter expression="${camel.applicationContextUri}"
      */
     protected String applicationContextUri;
+    
     /**
      * Project classpath.
      *

Modified: activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/RunMojo.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/RunMojo.java?rev=662224&r1=662223&r2=662224&view=diff
==============================================================================
--- activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/RunMojo.java (original)
+++ activemq/camel/trunk/tooling/maven/camel-maven-plugin/src/main/java/org/apache/camel/maven/RunMojo.java Sun Jun  1 07:39:06 2008
@@ -81,7 +81,8 @@
 
     /**
      * The duration to run the application for which by default is in
-     * milliseconds. A value <= 0 will
+     * milliseconds. A value <= 0 will run forever.
+     * Adding a s indicates seconds - eg "5s" means 5 seconds.
      *
      * @parameter expression="-1"
      * @readonly