Fix javadoc errors

Author: headius

gem-maven-plugin/src/main/java/de/saumya/mojo/gem/AbstractGemMojo.java

@@ -40,7 +40,7 @@ public abstract class AbstractGemMojo extends AbstractJRubyMojo {
 
     /**
      * flag whether to include open-ssl gem or not
-     * <br/>
+     *
      * Command line -Dgem.includeOpenSSL=...
      * 
      */
@@ -50,7 +50,7 @@ public abstract class AbstractGemMojo extends AbstractJRubyMojo {
 
     /**
      * flag whether to include all gems to test-resources, i.e. to test-classpath or not
-     * <br/>
+     *
      * Command line -Dgem.includeRubygemsInTestResources=...
      * 
      */
@@ -59,7 +59,7 @@ public abstract class AbstractGemMojo extends AbstractJRubyMojo {
 
     /**
      * flag whether to include all gems to resources, i.e. to classpath or not
-     * <br/>
+     *
      * Command line -Dgem.includeRubygemsInResources=...
      *
      */
@@ -68,10 +68,10 @@ public abstract class AbstractGemMojo extends AbstractJRubyMojo {
 
     /**
      * flag whether to include all gems to resources, i.e. to classpath or not
-     * <br/>
+     *
      * Command line -Dgem.includeProvidedRubygemsInResources=...
      *
-     * @parameter expression="${gem.includeProvidedRubygemsInResources}" default-value="false"
+     * parameter: expression="${gem.includeProvidedRubygemsInResources}" default-value="false"
      */
     @Parameter( defaultValue = "false", property = "gem.includeProvidedRubygemsInResources" )
     protected boolean       includeProvidedRubygemsInResources;
@@ -96,7 +96,7 @@ public abstract class AbstractGemMojo extends AbstractJRubyMojo {
      * for rubygems due to rubygems uses file system globs to find the gems and this
      * only works if the classloader reveals the jar url of its jars (i.e. URLClassLoader).
      * for example OSGi classloader can not work with rubygems !! 
-     * <br/>
+     *
      * Command line -Dgem.includeGemsInResources=...
      *
      */
@@ -107,7 +107,7 @@ public abstract class AbstractGemMojo extends AbstractJRubyMojo {
     /**
     /**
      * flag whether to include file under the lib directory
-     * <br/>
+     *
      * Command line -Dgem.includeLibDirectoryInResources=...
      *
      */
@@ -117,7 +117,7 @@ public abstract class AbstractGemMojo extends AbstractJRubyMojo {
 
     /**
      * flag whether to install rdocs of the used gems or not
-     * <br/>
+     *
      * Command line -Dgem.installRDoc=...
      * 
      */
@@ -126,7 +126,7 @@ public abstract class AbstractGemMojo extends AbstractJRubyMojo {
 
     /**
      * flag whether to install ri of the used gems or not
-     * <br/>
+     *
      * Command line -Dgem.installRDoc=...
      * 
      */
@@ -136,7 +136,7 @@ public abstract class AbstractGemMojo extends AbstractJRubyMojo {
     /**
      * use system gems instead of setting up GemPath/GemHome inside the build directory and ignores any set
      * gemHome and gemPath. you need to have both GEM_HOME and GEM_PATH environment variable set to make it work.
-     * <br/>
+     *
      * Command line -Dgem.useSystem=...
      *
      */
@@ -148,48 +148,43 @@ public abstract class AbstractGemMojo extends AbstractJRubyMojo {
      * compile dependencies will be installed in ${project.build.directory}/rubygems and
      * provided dependencies in ${project.build.directory}/rubygems-provided, and 
      * ${project.build.directory}/rubygems-test for the test scope. this mapping here allows
-     * to map those different directories onto a single one, i.e.: test => ${gem.home}, provided => ${gem.home}
-     * <br/>
-     *
+     * to map those different directories onto a single one, i.e.: test =&gt; ${gem.home}, provided =&gt; ${gem.home}
      */
     @Parameter( property = "gem.homes" )
     protected Map<String, String> gemHomes;
 
     /**
      * directory of gem home to use when forking JRuby. default will be ignored
      * when gemUseSystem is true.
-     * <br/>
-     * Command line -Dgem.home=...
      *
+     * Command line -Dgem.home=...
      */
     @Parameter( property = "gem.home", defaultValue = "${project.build.directory}/rubygems" )
     protected File               gemHome;
 
     /**
      * directory of JRuby path to use when forking JRuby. default will be ignored
      * when gemUseSystem is true.
-     * <br/>
-     * Command line -Dgem.path=...
      *
+     * Command line -Dgem.path=...
      */
     @Parameter( property = "gem.path", defaultValue = "${project.build.directory}/rubygems" )
     protected File          gemPath;
 
     /**
      * directory of JRuby bin path to use when forking JRuby.
-     * <br/>
-     * Command line -Dgem.binDirectory=...
      *
+     * Command line -Dgem.binDirectory=...
      */
     @Parameter( property = "gem.binDirectory" )
     protected File          binDirectory;
 
     /**
      * flag to indicate to setup jruby's native support for C-extensions
-     * <br/>
+     *
      * Command line -Dgem.supportNative=...
      * 
-     * @parameter expression="${gem.supportNative}" default-value="false"
+     * parameter: expression="${gem.supportNative}" default-value="false"
      */
     @Parameter( defaultValue = "false", property = "gem.supportNative" )
     @Deprecated

gem-maven-plugin/src/main/java/de/saumya/mojo/gem/ExecMojo.java

@@ -15,7 +15,7 @@
 /**
  * executes a ruby script in context of the gems from pom. the arguments for
  * jruby are build like this:
- * <code>${jruby.args} ${exec.file} ${exec.args} ${args}</code> <br/>
+ * <code>${jruby.args} ${exec.file} ${exec.args} ${args}</code>
  * to execute an inline script the exec parameters are ignored.
  */
 @Mojo( name = "exec", defaultPhase = LifecyclePhase.INITIALIZE, 

gem-maven-plugin/src/main/java/de/saumya/mojo/gem/GemMojo.java

@@ -10,7 +10,7 @@
 
 /**
  * goal to run gem with the given arguments.
- * <br/>
+ *
  * DEPRECATED - DO NOT USE
  */
 @Deprecated

gem-maven-plugin/src/main/java/de/saumya/mojo/gem/InstallMojo.java

@@ -26,7 +26,8 @@ public class InstallMojo extends AbstractGemMojo {
     protected String installArgs = null;
 
     /**
-     * gem file to install locally.<br/>
+     * gem file to install locally.
+     *
      * <b>Note:</b> this will install the gem in ${gem.home} so in general that is only
      * useful if some other goal does something with it
      */

jruby-maven-plugin/src/main/java/de/saumya/mojo/jruby/CompileMojo.java

@@ -15,8 +15,6 @@
 /**
  * executes the compiles ruby classes to java bytecode (jrubyc).
  * 
- * <br/>
- * 
  * NOTE: this goal uses only a small subset of the features of jrubyc.
  */
 @Mojo( name = "compile", defaultPhase = LifecyclePhase.COMPILE, 
@@ -32,7 +30,7 @@ public class CompileMojo extends AbstractJRubyMojo {
 
     /**
      * where the compiled class files are written unless you choose to generate
-     * java classes (needs >=jruby-1.5). default is the same as for java
+     * java classes (needs &gt;=jruby-1.5). default is the same as for java
      * classes.
      */
     @Parameter( property = "project.build.outputDirectory", defaultValue = "${project.build.outputDirectory}" )
@@ -51,13 +49,13 @@ public class CompileMojo extends AbstractJRubyMojo {
     protected boolean generateJava;
 
     /**
-     * where the java files (needs >=jruby-1.5).
+     * where the java files (needs &gt;=jruby-1.5).
      */
     @Parameter( defaultValue = "${basedir}/target/jrubyc-generated-sources" )
     protected File generatedJavaDirectory;
 
     /**
-     * verbose jrubyc related output (only with > jruby-1.6.x)
+     * verbose jrubyc related output (only with &gt; jruby-1.6.x)
      */
     @Parameter( property = "jrubyc.verbose", defaultValue = "false" )
     private boolean jrubycVerbose;

ruby-tools/src/main/java/de/saumya/mojo/gems/Maven2GemVersionConverter.java

@@ -17,8 +17,9 @@ public class Maven2GemVersionConverter
 
     /**
      * This is the pattern we match against. This is actually x.y.z... version format, that RubyGems 1.3.5 support.
-     * {@link http://github.com/jbarnette/rubygems/blob/REL_1_3_5/lib/rubygems/version.rb} and {@link http
-     * ://github.com/jbarnette/rubygems/blob/REL_1_3_6/lib/rubygems/version.rb}
+     *
+     * See http://github.com/jbarnette/rubygems/blob/REL_1_3_5/lib/rubygems/version.rb
+     * and http://github.com/jbarnette/rubygems/blob/REL_1_3_6/lib/rubygems/version.rb
      */
     public static final Pattern gemVersionPattern = Pattern.compile( "[0-9]+(\\.[0-9a-z]+)*" );
 

ruby-tools/src/main/java/de/saumya/mojo/gems/MavenArtifactConverter.java

@@ -17,7 +17,7 @@ public interface MavenArtifactConverter {
     /**
      * Returns is the artifact convertable safely into Gem.
      * 
-     * @param pom
+     * @param artifact
      * @return true if yes.
      */
     boolean canConvert(MavenArtifact artifact);
@@ -26,7 +26,7 @@ public interface MavenArtifactConverter {
      * Returns the "regular" gem filename, as it is expected this artifact to be
      * called as Gem.
      * 
-     * @param pom
+     * @param artifact
      * @return
      */
     String getGemFileName(MavenArtifact artifact);

ruby-tools/src/main/java/de/saumya/mojo/ruby/Logger.java

@@ -22,14 +22,14 @@ public interface Logger {
     /**
      * Send a message to the user in the <b>warn</b> level.
      * 
-     * @param content
+     * @param string
      */
     void warn(CharSequence string);
 
     /**
      * Send a message to the user in the <b>error</b> level.
      * 
-     * @param content
+     * @param string
      */
     void error(CharSequence string);
 }