You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2009/07/26 12:45:19 UTC
svn commit: r797904 - in /maven/plugins/trunk/maven-javadoc-plugin/src:
main/java/org/apache/maven/plugin/javadoc/ site/apt/ site/apt/examples/
Author: vsiveton
Date: Sun Jul 26 10:45:19 2009
New Revision: 797904
URL: http://svn.apache.org/viewvc?rev=797904&view=rev
Log:
o checkstyle + doc
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocUtil.java
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/fix-javadocs.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java?rev=797904&r1=797903&r2=797904&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java Sun Jul 26 10:45:19 2009
@@ -21,7 +21,6 @@
import java.io.BufferedReader;
import java.io.File;
-import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
@@ -403,6 +402,7 @@
// ----------------------------------------------------------------------
/**
+ * @param p not null maven project.
* @return the artifact type.
*/
protected String getArtifactType( MavenProject p )
@@ -422,7 +422,7 @@
/**
* @param p not null
* @return the compile classpath elements
- * @throws DependencyResolutionRequiredException
+ * @throws DependencyResolutionRequiredException if any
*/
protected List getCompileClasspathElements( MavenProject p )
throws DependencyResolutionRequiredException
@@ -767,11 +767,10 @@
*
* @return an array of {@link JavaClass} found by QDox
* @throws IOException if any
- * @throws FileNotFoundException if any
* @throws MojoExecutionException if any
*/
private JavaClass[] getQdoxClasses()
- throws FileNotFoundException, IOException, MojoExecutionException
+ throws IOException, MojoExecutionException
{
if ( "pom".equals( project.getPackaging().toLowerCase() ) )
{
@@ -971,14 +970,24 @@
* Take care of block or single comments between Javadoc comment and entity declaration ie:
* <br/>
* <code>
- * <font color="#808080">1</font> <font color="#ffffff"> </font><font color="#3f5fbf">/**</font><br />
- * <font color="#808080">2</font> <font color="#ffffff"> </font><font color="#3f5fbf">* {Javadoc Comment}</font><br />
- * <font color="#808080">3</font> <font color="#ffffff"> </font><font color="#3f5fbf">*/</font><br />
- * <font color="#808080">4</font> <font color="#ffffff"> </font><font color="#3f7f5f">/*</font><br />
- * <font color="#808080">5</font> <font color="#ffffff"> </font><font color="#3f7f5f">* {Block Comment}</font><br />
- * <font color="#808080">6</font> <font color="#ffffff"> </font><font color="#3f7f5f">*/</font><br />
- * <font color="#808080">7</font> <font color="#ffffff"> </font><font color="#3f7f5f">// {Single comment}</font><br />
- * <font color="#808080">8</font> <font color="#ffffff"> </font><font color="#7f0055"><b>public </b></font><font color="#7f0055"><b>void </b></font><font color="#000000">dummyMethod</font><font color="#000000">( </font><font color="#000000">String s </font><font color="#000000">){}</font>
+ * <font color="#808080">1</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">/**</font><br />
+ * <font color="#808080">2</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* {Javadoc Comment}</font><br />
+ * <font color="#808080">3</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">*/</font><br />
+ * <font color="#808080">4</font> <font color="#ffffff"> </font>
+ * <font color="#3f7f5f">/*</font><br />
+ * <font color="#808080">5</font> <font color="#ffffff"> </font>
+ * <font color="#3f7f5f">* {Block Comment}</font><br />
+ * <font color="#808080">6</font> <font color="#ffffff"> </font>
+ * <font color="#3f7f5f">*/</font><br />
+ * <font color="#808080">7</font> <font color="#ffffff"> </font>
+ * <font color="#3f7f5f">// {Single comment}</font><br />
+ * <font color="#808080">8</font> <font color="#ffffff"> </font>
+ * <font color="#7f0055"><b>public </b></font><font color="#7f0055"><b>void </b></font>
+ * <font color="#000000">dummyMethod</font><font color="#000000">( </font>
+ * <font color="#000000">String s </font><font color="#000000">){}</font>
* </code>
*
* @param stringWriter not null
@@ -1094,14 +1103,26 @@
* Add a default Javadoc for the given class, i.e.:
* <br/>
* <code>
- * <font color="#808080">1</font> <font color="#ffffff"> </font><font color="#3f5fbf">/**</font><br />
- * <font color="#808080">2</font> <font color="#ffffff"> </font><font color="#3f5fbf">* {Comment based on the class name}</font><br />
- * <font color="#808080">3</font> <font color="#ffffff"> </font><font color="#3f5fbf">*</font><br />
- * <font color="#808080">4</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@author </font><font color="#3f5fbf">X {added if addMissingAuthor}</font><br />
- * <font color="#808080">5</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@version </font><font color="#3f5fbf">X {added if addMissingVersion}</font><br />
- * <font color="#808080">6</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@since </font><font color="#3f5fbf">X {added if addMissingSince and new classes from previous version}</font><br />
- * <font color="#808080">7</font> <font color="#ffffff"> </font><font color="#3f5fbf">*/</font><br />
- * <font color="#808080">8</font> <font color="#7f0055"><b>public class </b></font><font color="#000000">DummyClass </font><font color="#000000">{}</font></code>
+ * <font color="#808080">1</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">/**</font><br />
+ * <font color="#808080">2</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* {Comment based on the class name}</font><br />
+ * <font color="#808080">3</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">*</font><br />
+ * <font color="#808080">4</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@author </font>
+ * <font color="#3f5fbf">X {added if addMissingAuthor}</font><br />
+ * <font color="#808080">5</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@version </font>
+ * <font color="#3f5fbf">X {added if addMissingVersion}</font><br />
+ * <font color="#808080">6</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@since </font>
+ * <font color="#3f5fbf">X {added if addMissingSince and new classes
+ * from previous version}</font><br />
+ * <font color="#808080">7</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">*/</font><br />
+ * <font color="#808080">8</font> <font color="#7f0055"><b>public class </b></font>
+ * <font color="#000000">DummyClass </font><font color="#000000">{}</font></code>
* </code>
*
* @param buffer not null
@@ -1196,8 +1217,14 @@
* Add a default Javadoc for the given field, i.e.:
* <br/>
* <code>
- * <font color="#808080">1</font> <font color="#ffffff"> </font><font color="#3f5fbf">/** Constant </font><font color="#7f7f9f"><code></font><font color="#3f5fbf">MY_STRING_CONSTANT="value"</font><font color="#7f7f9f"></code> </font><font color="#3f5fbf">*/</font><br />
- * <font color="#808080">2</font> <font color="#ffffff"> </font><font color="#7f0055"><b>public static final </b></font><font color="#000000">String MY_STRING_CONSTANT = </font><font color="#2a00ff">"value"</font><font color="#000000">;</font>
+ * <font color="#808080">1</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">/** Constant </font><font color="#7f7f9f"><code></font>
+ * <font color="#3f5fbf">MY_STRING_CONSTANT="value"</font>
+ * <font color="#7f7f9f"></code> </font><font color="#3f5fbf">*/</font><br />
+ * <font color="#808080">2</font> <font color="#ffffff"> </font>
+ * <font color="#7f0055"><b>public static final </b></font>
+ * <font color="#000000">String MY_STRING_CONSTANT = </font>
+ * <font color="#2a00ff">"value"</font><font color="#000000">;</font>
* </code>
*
* @param stringWriter not null
@@ -1311,15 +1338,31 @@
* Add in the buffer a default Javadoc for the given class:
* <br/>
* <code>
- * <font color="#808080">1</font> <font color="#ffffff"> </font><font color="#3f5fbf">/**</font><br />
- * <font color="#808080">2</font> <font color="#ffffff"> </font><font color="#3f5fbf">* {Comment based on the method name}</font><br />
- * <font color="#808080">3</font> <font color="#ffffff"> </font><font color="#3f5fbf">*</font><br />
- * <font color="#808080">4</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font><font color="#3f5fbf">X {added if addMissingParam}</font><br />
- * <font color="#808080">5</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@return </font><font color="#3f5fbf">X {added if addMissingReturn}</font><br />
- * <font color="#808080">6</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@throws </font><font color="#3f5fbf">X {added if addMissingThrows}</font><br />
- * <font color="#808080">7</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@since </font><font color="#3f5fbf">X {added if addMissingSince and new classes from previous version}</font><br />
- * <font color="#808080">8</font> <font color="#ffffff"> </font><font color="#3f5fbf">*/</font><br />
- * <font color="#808080">9</font> <font color="#7f0055"><b>public </b></font><font color="#7f0055"><b>void </b></font><font color="#000000">dummyMethod</font><font color="#000000">( </font><font color="#000000">String s </font><font color="#000000">){}</font>
+ * <font color="#808080">1</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">/**</font><br />
+ * <font color="#808080">2</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* {Comment based on the method name}</font><br />
+ * <font color="#808080">3</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">*</font><br />
+ * <font color="#808080">4</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font>
+ * <font color="#3f5fbf">X {added if addMissingParam}</font><br />
+ * <font color="#808080">5</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@return </font>
+ * <font color="#3f5fbf">X {added if addMissingReturn}</font><br />
+ * <font color="#808080">6</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@throws </font>
+ * <font color="#3f5fbf">X {added if addMissingThrows}</font><br />
+ * <font color="#808080">7</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@since </font>
+ * <font color="#3f5fbf">X {added if addMissingSince and new classes
+ * from previous version}</font><br />
+ * <font color="#808080">8</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">*/</font><br />
+ * <font color="#808080">9</font> <font color="#7f0055"><b>public </b></font>
+ * <font color="#7f0055"><b>void </b></font><font color="#000000">dummyMethod</font>
+ * <font color="#000000">( </font><font color="#000000">String s </font>
+ * <font color="#000000">){}</font>
* </code>
*
* @param buffer not null
@@ -1915,7 +1958,8 @@
if ( exception.getValue().endsWith( exceptionClassName ) )
{
- originalJavadocTag = StringUtils.replace( originalJavadocTag, exceptionClassName, exception.getValue() );
+ originalJavadocTag =
+ StringUtils.replace( originalJavadocTag, exceptionClassName, exception.getValue() );
if ( StringUtils.removeDuplicateWhitespace( originalJavadocTag ).trim()
.endsWith( "@" + THROWS_TAG + " " + exception.getValue() ) )
{
@@ -2370,7 +2414,7 @@
}
sb.append( indent ).append( " * @" ).append( PARAM_TAG ).append( " " );
- sb.append( "<" + typeParameter.getName() + ">");
+ sb.append( "<" + typeParameter.getName() + ">" );
sb.append( " " );
sb.append( getDefaultJavadocForType( typeParameter ) );
sb.append( EOL );
@@ -2731,7 +2775,7 @@
"java.lang." + exceptionClassName };
Class clazz = null;
- for ( int i = 0; i < potentialClassNames.length; i++)
+ for ( int i = 0; i < potentialClassNames.length; i++ )
{
try
{
@@ -2974,11 +3018,19 @@
*
* <code>
* <font color="#808080">1</font> <font color="#ffffff"></font><br />
- * <font color="#808080">2</font> <font color="#ffffff"> </font><font color="#3f5fbf">/**</font><br />
- * <font color="#808080">3</font> <font color="#ffffff"> </font><font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
- * <font color="#808080">4</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font><font color="#3f5fbf">s a String</font><br />
- * <font color="#808080">5</font> <font color="#ffffff"> </font><font color="#3f5fbf">*/</font><br />
- * <font color="#808080">6</font> <font color="#ffffff"> </font><font color="#7f0055"><b>public </b></font><font color="#7f0055"><b>void </b></font><font color="#000000">dummyMethod</font><font color="#000000">( </font><font color="#000000">String s </font><font color="#000000">){}</font><br />
+ * <font color="#808080">2</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">/**</font><br />
+ * <font color="#808080">3</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
+ * <font color="#808080">4</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font>
+ * <font color="#3f5fbf">s a String</font><br />
+ * <font color="#808080">5</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">*/</font><br />
+ * <font color="#808080">6</font> <font color="#ffffff"> </font>
+ * <font color="#7f0055"><b>public </b></font><font color="#7f0055"><b>void </b></font>
+ * <font color="#000000">dummyMethod</font><font color="#000000">( </font>
+ * <font color="#000000">String s </font><font color="#000000">){}</font><br />
* </code>
*
* <br/>
@@ -2986,7 +3038,8 @@
* <br/>
*
* <code>
- * <font color="#808080">1</font> <font color="#ffffff"> </font><font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
+ * <font color="#808080">1</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
* </code>
*
* @param javaClassContent original class content not null
@@ -3029,11 +3082,19 @@
*
* <code>
* <font color="#808080">1</font> <font color="#ffffff"></font><br />
- * <font color="#808080">2</font> <font color="#ffffff"> </font><font color="#3f5fbf">/**</font><br />
- * <font color="#808080">3</font> <font color="#ffffff"> </font><font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
- * <font color="#808080">4</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font><font color="#3f5fbf">s a String</font><br />
- * <font color="#808080">5</font> <font color="#ffffff"> </font><font color="#3f5fbf">*/</font><br />
- * <font color="#808080">6</font> <font color="#ffffff"> </font><font color="#7f0055"><b>public </b></font><font color="#7f0055"><b>void </b></font><font color="#000000">dummyMethod</font><font color="#000000">( </font><font color="#000000">String s </font><font color="#000000">){}</font><br />
+ * <font color="#808080">2</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">/**</font><br />
+ * <font color="#808080">3</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
+ * <font color="#808080">4</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font>
+ * <font color="#3f5fbf">s a String</font><br />
+ * <font color="#808080">5</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">*/</font><br />
+ * <font color="#808080">6</font> <font color="#ffffff"> </font>
+ * <font color="#7f0055"><b>public </b></font><font color="#7f0055"><b>void </b></font>
+ * <font color="#000000">dummyMethod</font><font color="#000000">( </font>
+ * <font color="#000000">String s </font><font color="#000000">){}</font><br />
* </code>
*
* <br/>
@@ -3041,7 +3102,9 @@
* <br/>
*
* <code>
- * <font color="#808080">1</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font><font color="#3f5fbf">s a String</font><br />
+ * <font color="#808080">1</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font>
+ * <font color="#3f5fbf">s a String</font><br />
* </code>
*
* @param javaClassContent original class content not null
@@ -3050,8 +3113,8 @@
* @return the javadoc comment for the entity without Javadoc tags.
* @throws IOException if any
*/
- private static String getJavadocComment( final String javaClassContent, final AbstractInheritableJavaEntity entity,
- final DocletTag docletTag )
+ private static String getJavadocComment( final String javaClassContent,
+ final AbstractInheritableJavaEntity entity, final DocletTag docletTag )
throws IOException
{
if ( docletTag.getValue() == null )
@@ -3110,11 +3173,19 @@
*
* <code>
* <font color="#808080">1</font> <font color="#ffffff"></font><br />
- * <font color="#808080">2</font> <font color="#ffffff"> </font><font color="#3f5fbf">/**</font><br />
- * <font color="#808080">3</font> <font color="#ffffff"> </font><font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
- * <font color="#808080">4</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font><font color="#3f5fbf">s a String</font><br />
- * <font color="#808080">5</font> <font color="#ffffff"> </font><font color="#3f5fbf">*/</font><br />
- * <font color="#808080">6</font> <font color="#ffffff"> </font><font color="#7f0055"><b>public </b></font><font color="#7f0055"><b>void </b></font><font color="#000000">dummyMethod</font><font color="#000000">( </font><font color="#000000">String s </font><font color="#000000">){}</font><br />
+ * <font color="#808080">2</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">/**</font><br />
+ * <font color="#808080">3</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
+ * <font color="#808080">4</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font>
+ * <font color="#3f5fbf">s a String</font><br />
+ * <font color="#808080">5</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">*/</font><br />
+ * <font color="#808080">6</font> <font color="#ffffff"> </font>
+ * <font color="#7f0055"><b>public </b></font><font color="#7f0055"><b>void </b></font>
+ * <font color="#000000">dummyMethod</font><font color="#000000">( </font>
+ * <font color="#000000">String s </font><font color="#000000">){}</font><br />
* </code>
*
* <br/>
@@ -3122,10 +3193,15 @@
* <br/>
*
* <code>
- * <font color="#808080">1</font> <font color="#ffffff"> </font><font color="#3f5fbf">/**</font><br />
- * <font color="#808080">2</font> <font color="#ffffff"> </font><font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
- * <font color="#808080">3</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font><font color="#3f5fbf">s a String</font><br />
- * <font color="#808080">4</font> <font color="#ffffff"> </font><font color="#3f5fbf">*/</font><br />
+ * <font color="#808080">1</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">/**</font><br />
+ * <font color="#808080">2</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
+ * <font color="#808080">3</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font>
+ * <font color="#3f5fbf">s a String</font><br />
+ * <font color="#808080">4</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">*/</font><br />
* </code>
*
* @param javaClassContent not null
@@ -3168,11 +3244,19 @@
*
* <code>
* <font color="#808080">1</font> <font color="#ffffff"></font><br />
- * <font color="#808080">2</font> <font color="#ffffff"> </font><font color="#3f5fbf">/**</font><br />
- * <font color="#808080">3</font> <font color="#ffffff"> </font><font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
- * <font color="#808080">4</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font><font color="#3f5fbf">s a String</font><br />
- * <font color="#808080">5</font> <font color="#ffffff"> </font><font color="#3f5fbf">*/</font><br />
- * <font color="#808080">6</font> <font color="#ffffff"> </font><font color="#7f0055"><b>public </b></font><font color="#7f0055"><b>void </b></font><font color="#000000">dummyMethod</font><font color="#000000">( </font><font color="#000000">String s </font><font color="#000000">){}</font><br />
+ * <font color="#808080">2</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">/**</font><br />
+ * <font color="#808080">3</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
+ * <font color="#808080">4</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font>
+ * <font color="#3f5fbf">s a String</font><br />
+ * <font color="#808080">5</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">*/</font><br />
+ * <font color="#808080">6</font> <font color="#ffffff"> </font>
+ * <font color="#7f0055"><b>public </b></font><font color="#7f0055"><b>void </b></font>
+ * <font color="#000000">dummyMethod</font><font color="#000000">( </font>
+ * <font color="#000000">String s </font><font color="#000000">){}</font><br />
* </code>
*
* <br/>
@@ -3180,8 +3264,11 @@
* <br/>
*
* <code>
- * <font color="#808080">1</font> <font color="#ffffff"> </font><font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
- * <font color="#808080">2</font> <font color="#ffffff"> </font><font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font><font color="#3f5fbf">s a String</font><br />
+ * <font color="#808080">1</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* Dummy Javadoc comment.</font><br />
+ * <font color="#808080">2</font> <font color="#ffffff"> </font>
+ * <font color="#3f5fbf">* </font><font color="#7f9fbf">@param </font>
+ * <font color="#3f5fbf">s a String</font><br />
* </code>
*
* @param javaClassContent not null
@@ -3189,7 +3276,8 @@
* @return return the original javadoc as String for the current entity
* @throws IOException if any
*/
- private static String extractOriginalJavadocContent( final String javaClassContent, final AbstractJavaEntity entity )
+ private static String extractOriginalJavadocContent( final String javaClassContent,
+ final AbstractJavaEntity entity )
throws IOException
{
if ( entity.getComment() == null )
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java?rev=797904&r1=797903&r2=797904&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java Sun Jul 26 10:45:19 2009
@@ -61,7 +61,6 @@
import org.apache.maven.model.Plugin;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.AbstractMojo;
-import org.apache.maven.plugin.DefaultPluginManager;
import org.apache.maven.plugin.javadoc.options.BootclasspathArtifact;
import org.apache.maven.plugin.javadoc.options.DocletArtifact;
import org.apache.maven.plugin.javadoc.options.Group;
@@ -103,7 +102,8 @@
* @version $Id$
* @since 2.0
* @requiresDependencyResolution compile
- * @see <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html">The Java API Documentation Generator, 1.4.2</a>
+ * @see <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html">
+ * The Java API Documentation Generator, 1.4.2</a>
*/
public abstract class AbstractJavadocMojo
extends AbstractMojo
@@ -4390,7 +4390,7 @@
*/
private String getFullJavadocGoal()
{
- String javadocVersion = null;
+ String javadocPluginVersion = null;
InputStream resourceAsStream = null;
try
{
@@ -4405,7 +4405,7 @@
if ( StringUtils.isNotEmpty( properties.getProperty( "version" ) ) )
{
- javadocVersion = properties.getProperty( "version" );
+ javadocPluginVersion = properties.getProperty( "version" );
}
}
}
@@ -4422,12 +4422,12 @@
sb.append( "org.apache.maven.plugins" ).append( ":" );
sb.append( "maven-javadoc-plugin" ).append( ":" );
- if ( StringUtils.isNotEmpty( javadocVersion ) )
+ if ( StringUtils.isNotEmpty( javadocPluginVersion ) )
{
- sb.append( javadocVersion ).append( ":" );
+ sb.append( javadocPluginVersion ).append( ":" );
}
- if ( TestJavadocReport.class.isAssignableFrom( getClass() ))
+ if ( TestJavadocReport.class.isAssignableFrom( getClass() ) )
{
sb.append( "test-javadoc" );
}
@@ -4514,8 +4514,8 @@
/**
* Using Maven, a Javadoc link is given by <code>${project.url}/apidocs</code>.
*
- * @return the detected Javadoc links using the Maven conventions for all dependencies defined in the current project
- * or an empty list.
+ * @return the detected Javadoc links using the Maven conventions for all dependencies defined in the current
+ * project or an empty list.
* @see #detectLinks
* @since 2.6
*/
@@ -4571,8 +4571,8 @@
}
/**
- * @return if {@link #detectJavaApiLink}, the Java API link based on the {@link #javaApiLinks} properties and the value of the
- * <code>source</code> parameter in the <code>org.apache.maven.plugins:maven-compiler-plugin</code>
+ * @return if {@link #detectJavaApiLink}, the Java API link based on the {@link #javaApiLinks} properties and the
+ * value of the <code>source</code> parameter in the <code>org.apache.maven.plugins:maven-compiler-plugin</code>
* defined in <code>${project.build.plugins}</code> or in <code>${project.build.pluginManagement}</code>,
* or the {@link #fJavadocVersion}, or <code>null</code> if not defined.
* @since 2.6
@@ -4589,13 +4589,13 @@
}
final String pluginId = "org.apache.maven.plugins:maven-compiler-plugin";
- float source = fJavadocVersion;
+ float sourceVersion = fJavadocVersion;
String sourceConfigured = getPluginParameter( project, pluginId, "source" );
if ( sourceConfigured != null )
{
try
{
- source = Float.parseFloat( sourceConfigured );
+ sourceVersion = Float.parseFloat( sourceConfigured );
}
catch ( NumberFormatException e )
{
@@ -4614,19 +4614,19 @@
}
String javaApiLink = null;
- if ( source >= 1.3f && source < 1.4f && javaApiLinks.getProperty( "api_1.3" ) != null )
+ if ( sourceVersion >= 1.3f && sourceVersion < 1.4f && javaApiLinks.getProperty( "api_1.3" ) != null )
{
javaApiLink = javaApiLinks.getProperty( "api_1.3" ).toString();
}
- else if ( source >= 1.4f && source < 1.5f && javaApiLinks.getProperty( "api_1.4" ) != null )
+ else if ( sourceVersion >= 1.4f && sourceVersion < 1.5f && javaApiLinks.getProperty( "api_1.4" ) != null )
{
javaApiLink = javaApiLinks.getProperty( "api_1.4" ).toString();
}
- else if ( source >= 1.5f && source < 1.6f && javaApiLinks.getProperty( "api_1.5" ) != null )
+ else if ( sourceVersion >= 1.5f && sourceVersion < 1.6f && javaApiLinks.getProperty( "api_1.5" ) != null )
{
javaApiLink = javaApiLinks.getProperty( "api_1.5" ).toString();
}
- else if ( source >= 1.6f && javaApiLinks.getProperty( "api_1.6" ) != null )
+ else if ( sourceVersion >= 1.6f && javaApiLinks.getProperty( "api_1.6" ) != null )
{
javaApiLink = javaApiLinks.getProperty( "api_1.6" ).toString();
}
@@ -4748,10 +4748,10 @@
/**
* @param p not null
- * @param pluginId not null key of the plugin defined in {@link org.apache.maven.model.Build#getPluginsAsMap()} or in
- * {@link org.apache.maven.model.PluginManagement#getPluginsAsMap()}
- * @return the Maven plugin defined in <code>${project.build.plugins}</code> or in <code>${project.build.pluginManagement}</code>,
- * or <code>null</code> if not defined.
+ * @param pluginId not null key of the plugin defined in {@link org.apache.maven.model.Build#getPluginsAsMap()}
+ * or in {@link org.apache.maven.model.PluginManagement#getPluginsAsMap()}
+ * @return the Maven plugin defined in <code>${project.build.plugins}</code> or in
+ * <code>${project.build.pluginManagement}</code>, or <code>null</code> if not defined.
* @since 2.6
*/
private static Plugin getPlugin( MavenProject p, String pluginId )
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocUtil.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocUtil.java?rev=797904&r1=797903&r2=797904&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocUtil.java (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocUtil.java Sun Jul 26 10:45:19 2009
@@ -84,7 +84,7 @@
public class JavadocUtil
{
/** The default timeout used when fetching url, i.e. 2000. */
- public static int DEFAULT_TIMEOUT = 2000;
+ public static final int DEFAULT_TIMEOUT = 2000;
/**
* Method that removes the invalid directories in the specified directories.
@@ -961,7 +961,7 @@
*
* @param log a logger could be null.
* @param localRepositoryDir the localRepository not null.
- * @param project a not null project file.
+ * @param projectFile a not null project file.
* @param goals a not null goals list.
* @param properties the properties for the goals, could be null.
* @param invokerLog the log file where the invoker will be written, if null using <code>System.out</code>.
@@ -1187,7 +1187,7 @@
OutputStream os = null;
if ( invokerLog != null )
{
- log.debug( "Using "+ invokerLog.getAbsolutePath() + " to log the invoker" );
+ log.debug( "Using " + invokerLog.getAbsolutePath() + " to log the invoker" );
try
{
@@ -1364,7 +1364,7 @@
*/
private static String getJavaOpts( Log log )
{
- String javaOpts= null;
+ String javaOpts = null;
try
{
javaOpts = CommandLineUtils.getSystemEnvVars().getProperty( "JAVA_OPTS" );
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/fix-javadocs.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/fix-javadocs.apt?rev=797904&r1=797903&r2=797904&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/fix-javadocs.apt (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/fix-javadocs.apt Sun Jul 26 10:45:19 2009
@@ -60,12 +60,7 @@
** Current limitations
The <fix> and <test-fix> goals use intensively {{{http://qdox.codehaus.org/}Qdox}} to extract class/interface/method
- Javadoc from source files. Unfortunately, Qdox has {{{http://jira.codehaus.org/browse/QDOX}some known issues}}, some
- of them could be blocker for your source files:
-
- * {{{http://jira.codehaus.org/browse/QDOX-154}QDOX-154}}: JavaMethod#getComment() is parsed with an implicit order
-
- []
+ Javadoc from source files. Unfortunately, Qdox has {{{http://jira.codehaus.org/browse/QDOX}some known issues}}.
* Example Call
@@ -95,12 +90,12 @@
* Using Clirr Integration
- <<Note>>: the artifact should be deploy firstly.
+ <<Note>>: a previous artifact should be deployed firstly.
** Comparing against a specific version
By default, the goals compare the current code against the latest released version, which is lower than the current
- version.
+ version. If you want to use another version, you need to specify it similar to the Maven Clirr Plugin:
+-----+
mvn javadoc:fix -DcomparisonVersion=1.0
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt?rev=797904&r1=797903&r2=797904&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt Sun Jul 26 10:45:19 2009
@@ -4,7 +4,7 @@
Maria Odea Ching
Vincent Siveton
------
- 2009-02-28
+ 2009-07-26
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -119,14 +119,22 @@
* {{{examples/javadoc-resources.html}Using Javadoc Resources}}
+ * {{{examples/output-configuration.html}Using Alternative Output Directory}}
+
* {{{examples/stylesheet-configuration.html}Configuring Stylesheets}}
+ * {{{examples/help-configuration.html}Configuring Helpfile}}
+
* {{{examples/tag-configuration.html}Configuring Custom Javadoc Tags}}
* {{{examples/taglet-configuration.html}Configuring Custom Javadoc Taglet}}
+ * {{{examples/links-configuration.html}Configuring Links}}
+
* {{{examples/test-javadocs.html}Generating test Javadocs}}
* {{{examples/selective-javadocs-report.html}Selective Javadocs Reports}}
+ * {{{examples/fix-javadocs.html}Fixing Javadoc Comments}}
+
[]