Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Resolving: MNG-704, allowing list syntax for tags in the javadoc configuration. NOTE: The old single-line tag config syntax is also still supported. 

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@320901 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
John Dennis Casey 2005-10-13 20:12:52 +00:00
parent 02eba11c6f
commit 7a1e687879
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
View File

@ -478,6 +478,18 @@ public class JavadocReport
*/ */
private String stylesheetfile; private String stylesheetfile;
/**
* Contains a list of tag names, which will result in conversion to support the following, from the javadoc
* API:
* <br/>
* Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
* See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tag">tag</a>.
* It is a comma separated String.
*
* @parameter expression="${tags}"
*/
private ArrayList tags;
/** /**
* Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. * Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
* See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tag">tag</a>. * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tag">tag</a>.
@ -824,7 +836,19 @@ public class JavadocReport
addArgIf( arguments, serialwarn, "-serialwarn" ); addArgIf( arguments, serialwarn, "-serialwarn" );
addArgIf( arguments, splitindex, "-splitindex" ); addArgIf( arguments, splitindex, "-splitindex" );
addArgIfNotEmpty( arguments, "-stylesheetfile", quotedPathArgument( stylesheetfile ) ); addArgIfNotEmpty( arguments, "-stylesheetfile", quotedPathArgument( stylesheetfile ) );
addArgIfNotEmpty( arguments, "-tag", quotedArgument( tag ), 1.4f, true ); addArgIfNotEmpty( arguments, "-tag", quotedArgument( tag ), 1.4f, true );
if ( tags != null && !tags.isEmpty() )
{
for ( Iterator it = tags.iterator(); it.hasNext(); )
{
String tag = (String) it.next();
addArgIfNotEmpty( arguments, "-tag", quotedArgument( tag ), 1.4f, true );
}
}
addArgIfNotEmpty( arguments, "-taglet", quotedArgument( taglet ), 1.4f ); addArgIfNotEmpty( arguments, "-taglet", quotedArgument( taglet ), 1.4f );
addArgIfNotEmpty( arguments, "-tagletpath", quotedPathArgument( tagletpath ), 1.4f ); addArgIfNotEmpty( arguments, "-tagletpath", quotedPathArgument( tagletpath ), 1.4f );
addArgIf( arguments, use, "-use" ); addArgIf( arguments, use, "-use" );