[MNG-6515] Fix Javadoc build errors
authorSylwester Lachiewicz <slachiewicz@apache.org>
Mon, 12 Nov 2018 14:28:48 +0000 (15:28 +0100)
committerSylwester Lachiewicz <slachiewicz@apache.org>
Mon, 12 Nov 2018 16:23:56 +0000 (17:23 +0100)
maven-core/src/main/java/org/apache/maven/artifact/repository/MavenArtifactRepository.java
maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java
maven-model-builder/src/main/java/org/apache/maven/model/interpolation/ModelInterpolator.java
maven-model/src/main/mdo/maven.mdo
maven-plugin-api/src/main/java/org/apache/maven/plugin/AbstractMojo.java
maven-settings/src/main/mdo/settings.mdo

index f04007e..76bb604 100644 (file)
@@ -215,7 +215,7 @@ public class MavenArtifactRepository
 
     /**
      * Return the protocol name.
-     * <br/>
+     * <br>
      * E.g: for input
      * <code>http://www.codehaus.org</code> this method will return <code>http</code>
      *
index 9d3b290..8244487 100644 (file)
@@ -34,7 +34,9 @@ import org.codehaus.plexus.util.introspection.ReflectionValueExtractor;
 
 /**
  * Evaluator for plugin parameters expressions. Content surrounded by <code>${</code> and <code>}</code> is evaluated.
- * Recognized values are:<table border="1" summary="Expression matrix">
+ * Recognized values are:
+ * <table border="1">
+ * <caption>Expression matrix</caption>
  * <tr><th>expression</th>                     <th></th>               <th>evaluation result</th></tr>
  * <tr><td><code>session</code></td>           <td></td>               <td>the actual {@link MavenSession}</td></tr>
  * <tr><td><code>session.*</code></td>         <td>(since Maven 3)</td><td></td></tr>
index 3b80c34..5fc4c9c 100644 (file)
@@ -26,7 +26,7 @@ import org.apache.maven.model.building.ModelProblemCollector;
 import java.io.File;
 
 /**
- * Replaces expressions of the form <tt>${token}</tt> with their effective values. Effective values are basically
+ * Replaces expressions of the form <code>${token}</code> with their effective values. Effective values are basically
  * calculated from the elements of the model itself and the execution properties from the building request.
  *
  * @author jdcasey
index 517ea5e..09035a3 100644 (file)
           <description>
             <![CDATA[
             The URL to the project's homepage.
-            <br /><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
+            <br><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
             project's <code>child.project.url.inherit.append.path="false"</code>
             ]]>
           </description>
             When childs inherit from project's url, append path or not? Note: While the type
             of this field is <code>String</code> for technical reasons, the semantic type is actually
             <code>Boolean</code>
-            <br /><b>Default value is</b>: <code>true</code>
-            <br /><b>Since</b>: Maven 3.6.1
+            <br><b>Default value is</b>: <code>true</code>
+            <br><b>Since</b>: Maven 3.6.1
             ]]>
           </description>
           <type>String</type>
             <a href="https://maven.apache.org/scm/scm-url-format.html">URL format</a>
             and <a href="https://maven.apache.org/scm/scms-overview.html">list of supported SCMs</a>.
             This connection is read-only.
-            <br /><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
+            <br><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
             scm's <code>child.scm.connection.inherit.append.path="false"</code>
             ]]>
           </description>
             <![CDATA[
             Just like <code>connection</code>, but for developers, i.e. this scm connection
             will not be read only.
-            <br /><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
+            <br><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
             scm's <code>child.scm.developerConnection.inherit.append.path="false"</code>
             ]]>
           </description>
           <description>
             <![CDATA[
             The URL to the project's browsable SCM repository, such as ViewVC or Fisheye.
-            <br /><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
+            <br><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
             scm's <code>child.scm.url.inherit.append.path="false"</code>
             ]]>
           </description>
             When childs inherit from scm connection, append path or not? Note: While the type
             of this field is <code>String</code> for technical reasons, the semantic type is actually
             <code>Boolean</code>
-            <br /><b>Default value is</b>: <code>true</code>
-            <br /><b>Since</b>: Maven 3.6.1
+            <br><b>Default value is</b>: <code>true</code>
+            <br><b>Since</b>: Maven 3.6.1
             ]]>
           </description>
           <type>String</type>
             When childs inherit from scm developer connection, append path or not? Note: While the type
             of this field is <code>String</code> for technical reasons, the semantic type is actually
             <code>Boolean</code>
-            <br /><b>Default value is</b>: <code>true</code>
-            <br /><b>Since</b>: Maven 3.6.1
+            <br><b>Default value is</b>: <code>true</code>
+            <br><b>Since</b>: Maven 3.6.1
             ]]>
           </description>
           <type>String</type>
             When childs inherit from scm url, append path or not? Note: While the type
             of this field is <code>String</code> for technical reasons, the semantic type is actually
             <code>Boolean</code>
-            <br /><b>Default value is</b>: <code>true</code>
-            <br /><b>Since</b>: Maven 3.6.1
+            <br><b>Default value is</b>: <code>true</code>
+            <br><b>Since</b>: Maven 3.6.1
             ]]>
           </description>
           <type>String</type>
           <description>
             <![CDATA[
             The url of the location where website is deployed, in the form <code>protocol://hostname/path</code>.
-            <br /><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
+            <br><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
             site's <code>child.site.url.inherit.append.path="false"</code>
             ]]>
           </description>
             When childs inherit from distribution management site url, append path or not? Note: While the type
             of this field is <code>String</code> for technical reasons, the semantic type is actually
             <code>Boolean</code>
-            <br /><b>Default value is</b>: <code>true</code>
-            <br /><b>Since</b>: Maven 3.6.1
+            <br><b>Default value is</b>: <code>true</code>
+            <br><b>Since</b>: Maven 3.6.1
             ]]>
           </description>
           <type>String</type>
     }
 
     /**
-     * @param groupId
-     * @param artifactId
+     * @param groupId The group ID of the plugin in the repository
+     * @param artifactId The artifact ID of the reporting plugin in the repository
      * @return the key of the plugin, ie <code>groupId:artifactId</code>
      */
     public static String constructKey( String groupId, String artifactId )
     }
 
     /**
-     * @param groupId
-     * @param artifactId
+     * @param groupId The group ID of the plugin in the repository
+     * @param artifactId The artifact ID of the reporting plugin in the repository
      * @return the key of the report plugin, ie <code>groupId:artifactId</code>
      */
     public static String constructKey( String groupId, String artifactId )
index 6292116..1a78549 100644 (file)
@@ -35,8 +35,9 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
  * There are also a number of attributes which can be used to control how and when the
  * <code>Mojo</code> is executed:
  * </p>
- * <table border="1" summary="mojo annotation attributes">
- *  <tr bgcolor="#CCCCCC">
+ * <table border="1">
+ *  <caption>mojo annotation attributes</caption>
+ *  <tr>
  *      <th>Descriptor Element</th>
  *      <th>Annotation</th>
  *      <th>Required?</th>
index 7547a9c..333d8bd 100644 (file)
           <required>true</required>
           <description>
             <![CDATA[
-            The local repository.<br><b>Default value is:</b> <tt>${user.home}/.m2/repository</tt>
+            The local repository.<br><b>Default value is:</b> <code>${user.home}/.m2/repository</code>
             ]]>
           </description>
           <type>String</type>