Author: hboutemy
Date: Fri Nov 28 00:10:50 2014
New Revision: 1642248
URL: http://svn.apache.org/r1642248
Log:
updated parent pom and fixed errors reported by Checkstyle
Modified:
maven/plugins/trunk/maven-javadoc-plugin/pom.xml
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/FixJavadocMojo.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocNoForkReport.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocUtil.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestFixJavadocMojo.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocJar.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocNoForkReport.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocReport.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestResourcesBundleMojo.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/resolver/JavadocBundle.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/resolver/ResourceResolver.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/resolver/SourceResolverConfig.java
Modified: maven/plugins/trunk/maven-javadoc-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/pom.xml?rev=1642248&r1=1642247&r2=1642248&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/pom.xml Fri Nov 28 00:10:50 2014
@@ -25,7 +25,7 @@ under the License.
<parent>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugins</artifactId>
- <version>25</version>
+ <version>27</version>
<relativePath>../maven-plugins/pom.xml</relativePath>
</parent>
@@ -65,9 +65,9 @@ under the License.
<doxiaVersion>1.0</doxiaVersion>
<doxia-sitetoolsVersion>1.0</doxia-sitetoolsVersion>
<wagonVersion>1.0-beta-6</wagonVersion>
+ <!-- for ITs -->
<sitePluginVersion>3.3</sitePluginVersion>
<projectInfoReportsPluginVersion>2.7</projectInfoReportsPluginVersion>
- <mavenPluginPluginVersion>3.2</mavenPluginPluginVersion>
</properties>
<contributors>
@@ -136,7 +136,6 @@ under the License.
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
- <version>${mavenPluginPluginVersion}</version>
<scope>provided</scope>
</dependency>
@@ -278,14 +277,6 @@ under the License.
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-plugin-plugin</artifactId>
- <version>${mavenPluginPluginVersion}</version>
- <configuration>
- <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>1.7.1</version>
</plugin>
@@ -293,7 +284,7 @@ under the License.
<groupId>org.apache.rat</groupId>
<artifactId>apache-rat-plugin</artifactId>
<configuration>
- <excludes>
+ <excludes combine.children="append">
<!-- Photoshop files are binary -->
<exclude>**/*.psd</exclude>
<!-- Checksum files cannot contain a license header -->
@@ -330,17 +321,6 @@ under the License.
</configuration>
</plugin>
<plugin>
- <artifactId>maven-plugin-plugin</artifactId>
- <executions>
- <execution>
- <id>generate-descriptor</id>
- <goals>
- <goal>descriptor</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- <plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
@@ -398,7 +378,6 @@ under the License.
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-invoker-plugin</artifactId>
<configuration>
- <cloneProjectsTo>${project.build.directory}/it</cloneProjectsTo>
<pomIncludes>
<pomInclude>additionnal-dependencies*/pom.xml</pomInclude>
<pomInclude>MJAVADOC-110/pom.xml</pomInclude>
@@ -424,7 +403,6 @@ under the License.
<pomInclude>MJAVADOC-369/pom.xml</pomInclude>
<pomInclude>MJAVADOC-407/pom.xml</pomInclude>
</pomIncludes>
-
<localRepositoryPath>${project.build.directory}/local-repo</localRepositoryPath>
</configuration>
</plugin>
</plugins>
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=1642248&r1=1642247&r2=1642248&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
Fri Nov 28 00:10:50 2014
@@ -80,7 +80,8 @@ import java.util.regex.Pattern;
/**
* Abstract class to fix Javadoc documentation and tags in source files.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#wheretags";>Where
Tags Can Be Used</a>.
+ * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#wheretags";>Where
Tags
+ * Can Be Used</a>.
*
* @author <a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</a>
* @version $Id$
@@ -442,10 +443,11 @@ public abstract class AbstractFixJavadoc
if ( javaClasses != null )
{
- for (JavaClass javaClass : javaClasses) {
- processFix(javaClass);
+ for ( JavaClass javaClass : javaClasses )
+ {
+ processFix( javaClass );
}
- }
+ }
}
catch ( IOException e )
{
@@ -528,14 +530,19 @@ public abstract class AbstractFixJavadoc
{
String[] split = StringUtils.split( fixTags, "," );
List<String> filtered = new LinkedList<String>();
- for (String aSplit : split) {
+ for ( String aSplit : split )
+ {
String s = aSplit.trim();
- if (JavadocUtil.equalsIgnoreCase(s, FIX_TAGS_ALL, AUTHOR_TAG,
VERSION_TAG, SINCE_TAG, PARAM_TAG,
- THROWS_TAG, LINK_TAG, RETURN_TAG)) {
- filtered.add(s);
- } else {
- if (getLog().isWarnEnabled()) {
- getLog().warn("Unrecognized '" + s + "' for fixTags
parameter. Ignored it!");
+ if ( JavadocUtil.equalsIgnoreCase( s, FIX_TAGS_ALL,
AUTHOR_TAG, VERSION_TAG, SINCE_TAG, PARAM_TAG,
+ THROWS_TAG, LINK_TAG,
RETURN_TAG ) )
+ {
+ filtered.add( s );
+ }
+ else
+ {
+ if ( getLog().isWarnEnabled() )
+ {
+ getLog().warn( "Unrecognized '" + s + "' for fixTags
parameter. Ignored it!" );
}
}
}
@@ -611,7 +618,7 @@ public abstract class AbstractFixJavadoc
getLog().info( "OK, let's proceed..." );
break;
}
- if (JavadocUtil.equalsIgnoreCase( userExpression, "N", "No" ))
+ if ( JavadocUtil.equalsIgnoreCase( userExpression, "N", "No" )
)
{
getLog().info( "No changes in your sources occur." );
return false;
@@ -673,7 +680,7 @@ public abstract class AbstractFixJavadoc
StringUtils.unifyLineSeparators( FileUtils.fileRead(
invokerLogFile, "UTF-8" ) );
// see
org.codehaus.mojo.clirr.AbstractClirrMojo#getComparisonArtifact()
final String artifactNotFoundMsg = "Unable to find a previous
version of the project in the repository";
- if (invokerLogContent.contains(artifactNotFoundMsg))
+ if ( invokerLogContent.contains( artifactNotFoundMsg ) )
{
getLog().warn( "No previous artifact has been deployed,
Clirr is ignored." );
return;
@@ -764,6 +771,7 @@ public abstract class AbstractFixJavadoc
// 8000 - Class Added
List<String> list;
String[] splits2;
+ // CHECKSTYLE_OFF: MagicNumber
switch ( code )
{
case 7011:
@@ -802,6 +810,7 @@ public abstract class AbstractFixJavadoc
default:
break;
}
+ // CHECKSTYLE_ON: MagicNumber
}
}
finally
@@ -830,8 +839,10 @@ public abstract class AbstractFixJavadoc
return true;
}
- for (String aFixTagsSplitted : fixTagsSplitted) {
- if (aFixTagsSplitted.trim().equals(tag)) {
+ for ( String aFixTagsSplitted : fixTagsSplitted )
+ {
+ if ( aFixTagsSplitted.trim().equals( tag ) )
+ {
return true;
}
}
@@ -932,7 +943,7 @@ public abstract class AbstractFixJavadoc
}
}
- projectClassLoader = new URLClassLoader(urls.toArray( new
URL[urls.size()] ), null );
+ projectClassLoader = new URLClassLoader( urls.toArray( new
URL[urls.size()] ), null );
}
return projectClassLoader;
@@ -1095,7 +1106,7 @@ public abstract class AbstractFixJavadoc
String extraComment = javadocComment.substring(
javadocComment.indexOf( END_JAVADOC ) + END_JAVADOC.length() );
if ( StringUtils.isNotEmpty( extraComment ) )
{
- if (extraComment.contains(EOL))
+ if ( extraComment.contains( EOL ) )
{
stringWriter.write( extraComment.substring(
extraComment.indexOf( EOL ) + EOL.length() ) );
}
@@ -1320,23 +1331,28 @@ public abstract class AbstractFixJavadoc
{
StringBuilder value = new StringBuilder();
String[] lines = getLines( field.getInitializationExpression()
);
- for (String line : lines) {
- StringTokenizer token = new StringTokenizer(line.trim(),
"\"\n\r");
- while (token.hasMoreTokens()) {
+ for ( String line : lines )
+ {
+ StringTokenizer token = new StringTokenizer( line.trim(),
"\"\n\r" );
+ while ( token.hasMoreTokens() )
+ {
String s = token.nextToken();
- if (s.trim().equals("+")) {
+ if ( s.trim().equals( "+" ) )
+ {
continue;
}
- if (s.trim().endsWith("\\")) {
+ if ( s.trim().endsWith( "\\" ) )
+ {
s += "\"";
}
- value.append(s);
+ value.append( s );
}
}
sb.append( "=\"" );
// reduce the size
+ // CHECKSTYLE_OFF: MagicNumber
if ( value.length() < 40 )
{
sb.append( value.toString() ).append( "\"" );
@@ -1345,6 +1361,7 @@ public abstract class AbstractFixJavadoc
{
sb.append( value.toString().substring( 0, 39 ) ).append(
"\"{trunked}" );
}
+ // CHECKSTYLE_ON: MagicNumber
}
}
@@ -1697,9 +1714,10 @@ public abstract class AbstractFixJavadoc
}
String[] lines = getLines( comment );
- for (String line : lines) {
- sb.append(indent).append(" ").append(line.trim());
- sb.append(EOL);
+ for ( String line : lines )
+ {
+ sb.append( indent ).append( " " ).append( line.trim() );
+ sb.append( EOL );
}
}
@@ -1918,8 +1936,9 @@ public abstract class AbstractFixJavadoc
for ( Iterator<String> it =
javaEntityTags.getUnknownTags().iterator(); it.hasNext(); )
{
String originalJavadocTag = it.next();
+ String simplified =
StringUtils.removeDuplicateWhitespace( originalJavadocTag ).trim();
- if
(StringUtils.removeDuplicateWhitespace(originalJavadocTag).trim().contains("@"
+ docletTag.getName()))
+ if ( simplified.contains( "@" + docletTag.getName() ) )
{
it.remove();
sb.append( originalJavadocTag );
@@ -1933,8 +1952,9 @@ public abstract class AbstractFixJavadoc
for ( Iterator<String> it =
javaEntityTags.getUnknownTags().iterator(); it.hasNext(); )
{
String originalJavadocTag = it.next();
+ String simplified = StringUtils.removeDuplicateWhitespace(
originalJavadocTag ).trim();
- if
(StringUtils.removeDuplicateWhitespace(originalJavadocTag).trim().contains("@"
+ docletTag.getName()))
+ if ( simplified.contains( "@" + docletTag.getName() ) )
{
it.remove();
sb.append( originalJavadocTag );
@@ -1952,8 +1972,8 @@ public abstract class AbstractFixJavadoc
}
}
- private void writeParamTag( final StringBuilder sb, final JavaMethod
javaMethod, final JavaEntityTags javaEntityTags,
- String[] params )
+ private void writeParamTag( final StringBuilder sb, final JavaMethod
javaMethod,
+ final JavaEntityTags javaEntityTags, String[]
params )
{
params = fixQdox173( params );
@@ -1976,8 +1996,10 @@ public abstract class AbstractFixJavadoc
{
// is generic?
TypeVariable[] typeParams = javaMethod.getTypeParameters();
- for (TypeVariable typeParam : typeParams) {
- if (typeParam.getGenericValue().equals(paramName)) {
+ for ( TypeVariable typeParam : typeParams )
+ {
+ if ( typeParam.getGenericValue().equals( paramName ) )
+ {
found = true;
}
}
@@ -2520,7 +2542,7 @@ public abstract class AbstractFixJavadoc
}
sb.append( indent ).append( " * @" ).append( PARAM_TAG ).append( " " );
- sb.append("<").append(typeParameter.getName()).append(">");
+ sb.append( "<" ).append( typeParameter.getName() ).append( ">" );
sb.append( " " );
sb.append( getDefaultJavadocForType( typeParameter ) );
sb.append( EOL );
@@ -3338,12 +3360,13 @@ public abstract class AbstractFixJavadoc
}
String originalJavadoc = extractOriginalJavadoc( javaClassContent,
entity );
- int index;
- if ( ( index = originalJavadoc.indexOf( START_JAVADOC ) ) != -1 )
+ int index = originalJavadoc.indexOf( START_JAVADOC );
+ if ( index != -1 )
{
originalJavadoc = originalJavadoc.substring( index +
START_JAVADOC.length() );
}
- if ( ( index = originalJavadoc.indexOf( END_JAVADOC ) ) != -1 )
+ index = originalJavadoc.indexOf( END_JAVADOC );
+ if ( index != -1 )
{
originalJavadoc = originalJavadoc.substring( 0, index );
}
@@ -3368,7 +3391,7 @@ public abstract class AbstractFixJavadoc
private static String removeLastEmptyJavadocLines( final String content )
throws IOException
{
- if (!content.contains(EOL))
+ if ( !content.contains( EOL ) )
{
return content;
}
@@ -3468,7 +3491,7 @@ public abstract class AbstractFixJavadoc
line = reader.readLine();
}
- return lines.toArray(new String[lines.size()]);
+ return lines.toArray( new String[lines.size()] );
}
/**
@@ -3541,7 +3564,7 @@ public abstract class AbstractFixJavadoc
l.remove( 0 );
l.remove( 1 );
- return l.toArray(new String[l.size()]);
+ return l.toArray( new String[l.size()] );
}
return params;
@@ -3656,7 +3679,8 @@ public abstract class AbstractFixJavadoc
private String getMessage( String paramName, String mapName )
{
StringBuilder msg = new StringBuilder();
- msg.append("No param '").append(paramName).append("' key found in
").append(mapName).append(" for the entity: ");
+ msg.append( "No param '" ).append( paramName ).append( "' key
found in " ).append( mapName )
+ .append( " for the entity: " );
if ( isJavaMethod )
{
JavaMethod javaMethod = (JavaMethod) entity;
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=1642248&r1=1642247&r2=1642248&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
Fri Nov 28 00:10:50 2014
@@ -154,7 +154,8 @@ public abstract class AbstractJavadocMoj
/**
* The default Javadoc API urls according the
- * <a
href="http://www.oracle.com/technetwork/java/javase/documentation/api-jsp-136079.html";>Sun
API Specifications</a>:
+ * <a
href="http://www.oracle.com/technetwork/java/javase/documentation/api-jsp-136079.html";>Sun
API
+ * Specifications</a>:
* <pre>
* <javaApiLinks>
* <property>
@@ -243,7 +244,8 @@ public abstract class AbstractJavadocMoj
/**
* For Javadoc options appears since Java 1.4.2.
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.2.html#commandlineoptions";>
+ * See <a
+ *
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.2.html#commandlineoptions";>
* What's New in Javadoc 1.4.2</a>
*
* @since 2.1
@@ -252,7 +254,8 @@ public abstract class AbstractJavadocMoj
/**
* For Javadoc options appears since Java 5.0.
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.5.0.html#commandlineoptions";>
+ * See <a
+ *
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.5.0.html#commandlineoptions";>
* What's New in Javadoc 5.0</a>
*
* @since 2.1
@@ -373,7 +376,8 @@ public abstract class AbstractJavadocMoj
* <br/>
* See <a
href="http://java.sun.com/javase/technologies/hotspot/vmoptions.jsp";>vmoptions</a>.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html";>Networking
Properties</a>.
+ * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html";>Networking
+ * Properties</a>.
*
* @since 2.3
*/
@@ -400,11 +404,11 @@ public abstract class AbstractJavadocMoj
* Example:
* <pre>
* <resourcesArtifacts>
- * <resourcesArtifact>
- * <groupId>external.group.id</groupId>
- *
<artifactId>external-resources</artifactId>
- * <version>1.0</version>
- * </resourcesArtifact>
+ * <resourcesArtifact>
+ * <groupId>external.group.id</groupId>
+ * <artifactId>external-resources</artifactId>
+ * <version>1.0</version>
+ * </resourcesArtifact>
* </resourcesArtifacts>
* </pre>
* <br/>
@@ -437,7 +441,8 @@ public abstract class AbstractJavadocMoj
/**
* Whether to build an aggregated report at the root, or build individual
reports.
*
- * @deprecated since 2.5. Use the goals <code>javadoc:aggregate</code> and
<code>javadoc:test-aggregate</code> instead.
+ * @deprecated since 2.5. Use the goals <code>javadoc:aggregate</code> and
<code>javadoc:test-aggregate</code>
+ * instead.
*/
@Parameter( property = "aggregate", defaultValue = "false" )
protected boolean aggregate;
@@ -491,17 +496,18 @@ public abstract class AbstractJavadocMoj
protected boolean failOnError;
/**
- * Specifies to use the <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#standard";>
+ * Specifies to use the
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#standard";>
* options provided by the Standard Doclet</a> for a custom doclet.
* <br/>
* Example:
* <pre>
* <docletArtifacts>
- * <docletArtifact>
- *
<groupId>com.sun.tools.doclets</groupId>
- * <artifactId>doccheck</artifactId>
- * <version>1.2b2</version>
- * </docletArtifact>
+ * <docletArtifact>
+ * <groupId>com.sun.tools.doclets</groupId>
+ * <artifactId>doccheck</artifactId>
+ * <version>1.2b2</version>
+ * </docletArtifact>
* </docletArtifacts>
* <useStandardDocletOptions>true</useStandardDocletOptions>
* </pre>
@@ -559,7 +565,9 @@ public abstract class AbstractJavadocMoj
* (defined in <code>${project.build.plugins}</code> or in
<code>${project.build.pluginManagement}</code>),
* or try to compute it from the {@link #javadocExecutable} version.
* <br/>
- * See <a
href="./apidocs/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.html#DEFAULT_JAVA_API_LINKS">Javadoc</a>
for the default values.
+ * See
+ * <a
href="./apidocs/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.html#DEFAULT_JAVA_API_LINKS">Javadoc</a>
+ * for the default values.
* <br/>
*
* @see #links
@@ -574,7 +582,8 @@ public abstract class AbstractJavadocMoj
* Use this parameter <b>only</b> if the <a
href="http://java.sun.com/reference/api/index.html";>Sun Javadoc API</a>
* urls have been changed or to use custom urls for Javadoc API url.
* <br/>
- * See <a
href="./apidocs/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.html#DEFAULT_JAVA_API_LINKS">Javadoc</a>
+ * See
+ * <a
href="./apidocs/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.html#DEFAULT_JAVA_API_LINKS">Javadoc</a>
* for the default values.
* <br/>
*
@@ -601,7 +610,8 @@ public abstract class AbstractJavadocMoj
* Specifies the paths where the boot classes reside. The
<code>bootclasspath</code> can contain multiple paths
* by separating them with a colon (<code>:</code>) or a semi-colon
(<code>;</code>).
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#bootclasspath";>bootclasspath</a>.
+ * See <a
+ *
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#bootclasspath";>bootclasspath</a>.
* <br/>
*
* @since 2.5
@@ -612,16 +622,17 @@ public abstract class AbstractJavadocMoj
/**
* Specifies the artifacts where the boot classes reside.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#bootclasspath";>bootclasspath</a>.
+ * See <a
+ *
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#bootclasspath";>bootclasspath</a>.
* <br/>
* Example:
* <pre>
* <bootclasspathArtifacts>
- * <bootclasspathArtifact>
- * <groupId>my-groupId</groupId>
- *
<artifactId>my-artifactId</artifactId>
- * <version>my-version</version>
- * </bootclasspathArtifact>
+ * <bootclasspathArtifact>
+ * <groupId>my-groupId</groupId>
+ * <artifactId>my-artifactId</artifactId>
+ * <version>my-version</version>
+ * </bootclasspathArtifact>
* </bootclasspathArtifacts>
* </pre>
* <br/>
@@ -636,9 +647,11 @@ public abstract class AbstractJavadocMoj
/**
* Uses the sentence break iterator to determine the end of the first
sentence.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#breakiterator";>breakiterator</a>.
+ * See <a
+ *
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#breakiterator";>breakiterator</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
+ * 1.4</a>.
* <br/>
*/
@Parameter( property = "breakiterator", defaultValue = "false" )
@@ -656,14 +669,15 @@ public abstract class AbstractJavadocMoj
* Specifies the artifact containing the doclet starting class file
(specified with the <code>-doclet</code>
* option).
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#docletpath";>docletpath</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#docletpath";>docletpath</a>.
* <br/>
* Example:
* <pre>
* <docletArtifact>
- * <groupId>com.sun.tools.doclets</groupId>
- * <artifactId>doccheck</artifactId>
- * <version>1.2b2</version>
+ * <groupId>com.sun.tools.doclets</groupId>
+ * <artifactId>doccheck</artifactId>
+ * <version>1.2b2</version>
* </docletArtifact>
* </pre>
* <br/>
@@ -677,16 +691,17 @@ public abstract class AbstractJavadocMoj
* Specifies multiple artifacts containing the path for the doclet
starting class file (specified with the
* <code>-doclet</code> option).
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#docletpath";>docletpath</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#docletpath";>docletpath</a>.
* <br/>
* Example:
* <pre>
* <docletArtifacts>
- * <docletArtifact>
- *
<groupId>com.sun.tools.doclets</groupId>
- * <artifactId>doccheck</artifactId>
- * <version>1.2b2</version>
- * </docletArtifact>
+ * <docletArtifact>
+ * <groupId>com.sun.tools.doclets</groupId>
+ * <artifactId>doccheck</artifactId>
+ * <version>1.2b2</version>
+ * </docletArtifact>
* </docletArtifacts>
* </pre>
* <br/>
@@ -703,7 +718,8 @@ public abstract class AbstractJavadocMoj
* any jar files it depends on. The <code>docletPath</code> can contain
multiple paths by separating them with
* a colon (<code>:</code>) or a semi-colon (<code>;</code>).
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#docletpath";>docletpath</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#docletpath";>docletpath</a>.
*/
@Parameter( property = "docletPath" )
private String docletPath;
@@ -733,7 +749,8 @@ public abstract class AbstractJavadocMoj
* <br/>
* See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#exclude";>exclude</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
+ * 1.4</a>.
*/
@Parameter( property = "excludePackageNames" )
private String excludePackageNames;
@@ -853,11 +870,13 @@ public abstract class AbstractJavadocMoj
private String show;
/**
- * Necessary to enable javadoc to handle assertions introduced in J2SE v
1.4 source code or generics introduced in J2SE v5.
+ * Necessary to enable javadoc to handle assertions introduced in J2SE v
1.4 source code or generics introduced in
+ * J2SE v5.
* <br/>
* See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#source";>source</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
+ * 1.4</a>.
*/
@Parameter( property = "source" )
private String source;
@@ -866,7 +885,8 @@ public abstract class AbstractJavadocMoj
* Specifies the source paths where the subpackages are located. The
<code>sourcepath</code> can contain
* multiple paths by separating them with a colon (<code>:</code>) or a
semi-colon (<code>;</code>).
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#sourcepath";>sourcepath</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#sourcepath";>sourcepath</a>.
*/
@Parameter( property = "sourcepath" )
private String sourcepath;
@@ -875,9 +895,11 @@ public abstract class AbstractJavadocMoj
* Specifies the package directory where javadoc will be executed.
Multiple packages can be separated by
* colons (<code>:</code>).
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#subpackages";>subpackages</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#subpackages";>subpackages</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
+ * 1.4</a>.
*/
@Parameter( property = "subpackages" )
private String subpackages;
@@ -913,7 +935,8 @@ public abstract class AbstractJavadocMoj
* <br/>
*/
@Parameter( property = "bottom",
- defaultValue = "Copyright ©
{inceptionYear}–{currentYear} {organizationName}. All rights reserved." )
+ defaultValue = "Copyright ©
{inceptionYear}–{currentYear} {organizationName}. "
+ + "All rights reserved." )
private String bottom;
/**
@@ -930,7 +953,8 @@ public abstract class AbstractJavadocMoj
* Specifies the encoding of the generated HTML files. If not specificed,
the docencoding value will be
* <code>UTF-8</code>.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#docencoding";>docencoding</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#docencoding";>docencoding</a>.
*/
@Parameter( property = "docencoding", defaultValue =
"${project.reporting.outputEncoding}" )
private String docencoding;
@@ -943,7 +967,8 @@ public abstract class AbstractJavadocMoj
* See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#docfilessubdirs";>
* docfilessubdirs</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
+ * 1.4</a>.
* <br/>
* See <a href="#javadocDirectory">javadocDirectory</a>.
* <br/>
@@ -970,7 +995,8 @@ public abstract class AbstractJavadocMoj
* See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#excludedocfilessubdir";>
* excludedocfilessubdir</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
+ * 1.4</a>.
*
* @see #docfilessubdirs
*/
@@ -994,19 +1020,19 @@ public abstract class AbstractJavadocMoj
* Example:
* <pre>
* <groups>
- * <group>
- * <title>Core Packages</title>
- * <!-- To includes java.lang, java.lang.ref,
- * java.lang.reflect and only java.util
- * (i.e. not java.util.jar) -->
- *
<packages>java.lang*:java.util</packages>
- * </group>
- * <group>
- * <title>Extension Packages</title>
- * <!-- To include javax.accessibility,
- * javax.crypto, ... (among others) -->
- * <packages>javax.*</packages>
- * </group>
+ * <group>
+ * <title>Core Packages</title>
+ * <!-- To includes java.lang, java.lang.ref,
+ * java.lang.reflect and only java.util
+ * (i.e. not java.util.jar) -->
+ * <packages>java.lang*:java.util</packages>
+ * </group>
+ * <group>
+ * <title>Extension Packages</title>
+ * <!-- To include javax.accessibility,
+ * javax.crypto, ... (among others) -->
+ * <packages>javax.*</packages>
+ * </group>
* </groups>
* </pre>
* <b>Note</b>: using <code>java.lang.*</code> for <code>packages</code>
would omit the <code>java.lang</code>
@@ -1045,24 +1071,24 @@ public abstract class AbstractJavadocMoj
* Where <code>path/to/your/resource/yourhelp-doc.html</code> could be in
<code>src/main/javadoc</code>.
* <pre>
* <build>
- * <plugins>
- * <plugin>
- *
<groupId>org.apache.maven.plugins</groupId>
- *
<artifactId>maven-javadoc-plugin</artifactId>
- * <configuration>
- *
<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>
- * ...
- * </configuration>
- * <dependencies>
- * <dependency>
- *
<groupId>groupId</groupId>
- *
<artifactId>artifactId</artifactId>
- *
<version>version</version>
- * </dependency>
- * </dependencies>
- * </plugin>
- * ...
- * <plugins>
+ * <plugins>
+ * <plugin>
+ * <groupId>org.apache.maven.plugins</groupId>
+ * <artifactId>maven-javadoc-plugin</artifactId>
+ * <configuration>
+ *
<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>
+ * ...
+ * </configuration>
+ * <dependencies>
+ * <dependency>
+ * <groupId>groupId</groupId>
+ * <artifactId>artifactId</artifactId>
+ * <version>version</version>
+ * </dependency>
+ * </dependencies>
+ * </plugin>
+ * ...
+ * <plugins>
* </build>
* </pre>
* Where <code>path/to/your/resource/yourhelp-doc.html</code> is defined
in the
@@ -1078,10 +1104,12 @@ public abstract class AbstractJavadocMoj
* <br/>
* See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#keywords";>keywords</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.2.html#commandlineoptions";>
+ * Since
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.2.html#commandlineoptions";>
* Java 1.4.2</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.5.0.html#commandlineoptions";>
+ * Since
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.5.0.html#commandlineoptions";>
* Java 5.0</a>.
* <br/>
*
@@ -1099,7 +1127,7 @@ public abstract class AbstractJavadocMoj
* <li>all given links should have a fetchable <code>/package-list</code>
file. For instance:
* <pre>
* <links>
- *
<link>http://docs.oracle.com/javase/1.4.2/docs/api</link>
+ * <link>http://docs.oracle.com/javase/1.4.2/docs/api</link>
* <links>
* </pre>
* will be used because
<code>http://docs.oracle.com/javase/1.4.2/docs/api/package-list</code>
exists.</li>
@@ -1120,9 +1148,11 @@ public abstract class AbstractJavadocMoj
* Creates an HTML version of each source file (with line numbers) and
adds links to them from the standard
* HTML documentation.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#linksource";>linksource</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#linksource";>linksource</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
+ * 1.4</a>.
* <br/>
*/
@Parameter( property = "linksource", defaultValue = "false" )
@@ -1133,7 +1163,8 @@ public abstract class AbstractJavadocMoj
* <br/>
* See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#nocomment";>nocomment</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
+ * 1.4</a>.
* <br/>
*/
@Parameter( property = "nocomment", defaultValue = "false" )
@@ -1142,7 +1173,9 @@ public abstract class AbstractJavadocMoj
/**
* Prevents the generation of any deprecated API at all in the
documentation.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#nodeprecated";>nodeprecated</a>.
+ * See
+ * <a
+ *
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#nodeprecated";>nodeprecated</a>.
* <br/>
*/
@Parameter( property = "nodeprecated", defaultValue = "false" )
@@ -1211,9 +1244,11 @@ public abstract class AbstractJavadocMoj
* or
* <noqualifier>packagename1:packagename2</noqualifier>
* </pre>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#noqualifier";>noqualifier</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#noqualifier";>noqualifier</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
+ * 1.4</a>.
*/
@Parameter( property = "noqualifier" )
private String noqualifier;
@@ -1230,9 +1265,11 @@ public abstract class AbstractJavadocMoj
/**
* Suppresses the timestamp, which is hidden in an HTML comment in the
generated HTML near the top of each page.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#notimestamp";>notimestamp</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#notimestamp";>notimestamp</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.5.0.html#commandlineoptions";>
+ * Since
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.5.0.html#commandlineoptions";>
* Java 5.0</a>.
* <br/>
*
@@ -1254,15 +1291,16 @@ public abstract class AbstractJavadocMoj
* This option is a variation of <code>-link</code>; they both create
links to javadoc-generated documentation
* for external referenced classes.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#linkoffline";>linkoffline</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#linkoffline";>linkoffline</a>.
* <br/>
* Example:
* <pre>
* <offlineLinks>
- * <offlineLink>
- *
<url>http://docs.oracle.com/javase/1.5.0/docs/api/</url>
- *
<location>../javadoc/jdk-5.0/</location>
- * </offlineLink>
+ * <offlineLink>
+ * <url>http://docs.oracle.com/javase/1.5.0/docs/api/</url>
+ * <location>../javadoc/jdk-5.0/</location>
+ * </offlineLink>
* </offlineLinks>
* </pre>
* <br/>
@@ -1288,7 +1326,8 @@ public abstract class AbstractJavadocMoj
/**
* Specify the text for upper left frame.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.2.html#commandlineoptions";>
+ * Since
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.2.html#commandlineoptions";>
* Java 1.4.2</a>.
*
* @since 2.1
@@ -1312,7 +1351,8 @@ public abstract class AbstractJavadocMoj
* Note: was <code>linksourcetab</code> in Java 1.4.2 (refer to bug ID
* <a
href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4788919";>4788919</a>).
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.2.html#commandlineoptions";>
+ * Since
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.2.html#commandlineoptions";>
* 1.4.2</a>.
* <br/>
* Since Java 5.0.
@@ -1328,7 +1368,8 @@ public abstract class AbstractJavadocMoj
* <br/>
* <b>Note</b>: could be in conflict with <noindex/>.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#splitindex";>splitindex</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#splitindex";>splitindex</a>.
* <br/>
*/
@Parameter( property = "splitindex", defaultValue = "false" )
@@ -1358,24 +1399,24 @@ public abstract class AbstractJavadocMoj
* Where <code>path/to/your/resource/yourstylesheet.css</code> could be in
<code>src/main/javadoc</code>.
* <pre>
* <build>
- * <plugins>
- * <plugin>
- *
<groupId>org.apache.maven.plugins</groupId>
- *
<artifactId>maven-javadoc-plugin</artifactId>
- * <configuration>
- *
<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
- * ...
- * </configuration>
- * <dependencies>
- * <dependency>
- *
<groupId>groupId</groupId>
- *
<artifactId>artifactId</artifactId>
- *
<version>version</version>
- * </dependency>
- * </dependencies>
- * </plugin>
- * ...
- * <plugins>
+ * <plugins>
+ * <plugin>
+ * <groupId>org.apache.maven.plugins</groupId>
+ * <artifactId>maven-javadoc-plugin</artifactId>
+ * <configuration>
+ *
<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
+ * ...
+ * </configuration>
+ * <dependencies>
+ * <dependency>
+ * <groupId>groupId</groupId>
+ * <artifactId>artifactId</artifactId>
+ * <version>version</version>
+ * </dependency>
+ * </dependencies>
+ * </plugin>
+ * ...
+ * <plugins>
* </build>
* </pre>
* Where <code>path/to/your/resource/yourstylesheet.css</code> is defined
in the
@@ -1392,7 +1433,8 @@ public abstract class AbstractJavadocMoj
* <br/>
* See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#taglet";>taglet</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
*/
@Parameter( property = "taglet" )
private String taglet;
@@ -1400,23 +1442,24 @@ public abstract class AbstractJavadocMoj
/**
* Specifies the Taglet artifact containing the taglet class files
(.class).
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#tagletpath";>tagletpath</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#tagletpath";>tagletpath</a>.
* <br/>
* Example:
* <pre>
* <taglets>
- * <taglet>
- *
<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>
- * </taglet>
- * <taglet>
- *
<tagletClass>package.to.AnotherTagletClass</tagletClass>
- * </taglet>
- * ...
+ * <taglet>
+ *
<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>
+ * </taglet>
+ * <taglet>
+ * <tagletClass>package.to.AnotherTagletClass</tagletClass>
+ * </taglet>
+ * ...
* </taglets>
* <tagletArtifact>
- * <groupId>group-Taglet</groupId>
- * <artifactId>artifact-Taglet</artifactId>
- * <version>version-Taglet</version>
+ * <groupId>group-Taglet</groupId>
+ * <artifactId>artifact-Taglet</artifactId>
+ * <version>version-Taglet</version>
* </tagletArtifact>
* </pre>
* <br/>
@@ -1434,17 +1477,18 @@ public abstract class AbstractJavadocMoj
* <br/>
* See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#taglet";>taglet</a>.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#tagletpath";>tagletpath</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#tagletpath";>tagletpath</a>.
* <br/>
* Example:
* <pre>
* <tagletArtifacts>
- * <tagletArtifact>
- * <groupId>group-Taglet</groupId>
- *
<artifactId>artifact-Taglet</artifactId>
- * <version>version-Taglet</version>
- * </tagletArtifact>
- * ...
+ * <tagletArtifact>
+ * <groupId>group-Taglet</groupId>
+ * <artifactId>artifact-Taglet</artifactId>
+ * <version>version-Taglet</version>
+ * </tagletArtifact>
+ * ...
* </tagletArtifacts>
* </pre>
* <br/>
@@ -1460,9 +1504,11 @@ public abstract class AbstractJavadocMoj
* Specifies the search paths for finding taglet class files (.class). The
<code>tagletpath</code> can contain
* multiple paths by separating them with a colon (<code>:</code>) or a
semi-colon (<code>;</code>).
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#tagletpath";>tagletpath</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#tagletpath";>tagletpath</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
*/
@Parameter( property = "tagletpath" )
private String tagletpath;
@@ -1472,20 +1518,21 @@ public abstract class AbstractJavadocMoj
* <br/>
* See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#taglet";>taglet</a>.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#tagletpath";>tagletpath</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#tagletpath";>tagletpath</a>.
* <br/>
* Example:
* <pre>
* <taglets>
- * <taglet>
- *
<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>
- *
<!--<tagletpath>/home/taglets</tagletpath>-->
- * <tagletArtifact>
- *
<groupId>group-Taglet</groupId>
- *
<artifactId>artifact-Taglet</artifactId>
- *
<version>version-Taglet</version>
- * </tagletArtifact>
- * </taglet>
+ * <taglet>
+ *
<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>
+ * <!--<tagletpath>/home/taglets</tagletpath>-->
+ * <tagletArtifact>
+ * <groupId>group-Taglet</groupId>
+ * <artifactId>artifact-Taglet</artifactId>
+ * <version>version-Taglet</version>
+ * </tagletArtifact>
+ * </taglet>
* </taglets>
* </pre>
* <br/>
@@ -1502,16 +1549,17 @@ public abstract class AbstractJavadocMoj
* <br/>
* See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#tag";>tag</a>.
* <br/>
- * Since <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * Since
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
* <br/>
* Example:
* <pre>
* <tags>
- * <tag>
- * <name>todo</name>
- * <placement>a</placement>
- * <head>To Do:</head>
- * </tag>
+ * <tag>
+ * <name>todo</name>
+ * <placement>a</placement>
+ * <head>To Do:</head>
+ * </tag>
* </tags>
* </pre>
* <b>Note</b>: the placement should be a combinaison of Xaoptcmf letters:
@@ -1564,7 +1612,8 @@ public abstract class AbstractJavadocMoj
/**
* Specifies the title to be placed in the HTML title tag.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#windowtitle";>windowtitle</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#windowtitle";>windowtitle</a>.
* <br/>
*/
@Parameter( property = "windowtitle", defaultValue = "${project.name}
${project.version} API" )
@@ -1638,11 +1687,11 @@ public abstract class AbstractJavadocMoj
* Exemple:
* <pre>
* <additionalDependencies>
- * <additionalDependency>
- * <groupId>geronimo-spec</groupId>
- *
<artifactId>geronimo-spec-jta</artifactId>
- * <version>1.0.1B-rc4:</version>
- * </additionalDependency>
+ * <additionalDependency>
+ * <groupId>geronimo-spec</groupId>
+ * <artifactId>geronimo-spec-jta</artifactId>
+ * <version>1.0.1B-rc4:</version>
+ * </additionalDependency>
* </additionalDependencies>
* </pre>
*
@@ -1669,7 +1718,7 @@ public abstract class AbstractJavadocMoj
* To apply the security fix on generated javadoc see
http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2013-1571
* @since 2.9.1
*/
- @Parameter(defaultValue = "true", property =
"maven.javadoc.applyJavadocSecurityFix")
+ @Parameter( defaultValue = "true", property =
"maven.javadoc.applyJavadocSecurityFix" )
private boolean applyJavadocSecurityFix = true;
// ----------------------------------------------------------------------
@@ -2084,7 +2133,8 @@ public abstract class AbstractJavadocMoj
for ( String sourcePath : sourcePaths )
{
File sourceDirectory = new File( sourcePath );
- JavadocUtil.addFilesFromSource( files, sourceDirectory,
sourceFileIncludes, sourceFileExcludes, excludedPackages );
+ JavadocUtil.addFilesFromSource( files, sourceDirectory,
sourceFileIncludes, sourceFileExcludes,
+ excludedPackages );
}
}
@@ -2155,7 +2205,8 @@ public abstract class AbstractJavadocMoj
if ( getJavadocDirectory() != null )
{
String javadocDirRelative =
- PathUtils.toRelative(
project.getBasedir(), getJavadocDirectory().getAbsolutePath() );
+ PathUtils.toRelative( project.getBasedir(),
+
getJavadocDirectory().getAbsolutePath() );
File javadocDir = new File(
subProject.getBasedir(), javadocDirRelative );
if ( javadocDir.exists() &&
javadocDir.isDirectory() )
{
@@ -3529,7 +3580,7 @@ public abstract class AbstractJavadocMoj
if ( !javadocExe.isFile() )
{
throw new IOException( "The javadoc executable '" + javadocExe
- + "' doesn't exist or is not a
file. Verify the <javadocExecutable/> parameter." );
+ + "' doesn't exist or is not a file. Verify the
<javadocExecutable/> parameter." );
}
return javadocExe.getAbsolutePath();
@@ -3547,7 +3598,9 @@ public abstract class AbstractJavadocMoj
new File( SystemUtils.getJavaHome() + File.separator + ".." +
File.separator + "sh", javadocCommand );
}
// For Apple's JDK 1.6.x (and older?) on Mac OSX
+ // CHECKSTYLE_OFF: MagicNumber
else if ( SystemUtils.IS_OS_MAC_OSX && SystemUtils.JAVA_VERSION_FLOAT
< 1.7f )
+ // CHECKSTYLE_ON: MagicNumber
{
javadocExe = new File( SystemUtils.getJavaHome() + File.separator
+ "bin", javadocCommand );
}
@@ -3568,10 +3621,11 @@ public abstract class AbstractJavadocMoj
{
throw new IOException( "The environment variable JAVA_HOME is
not correctly set." );
}
- if ( ( !new File( javaHome ).getCanonicalFile().exists() ) || (
new File( javaHome ).getCanonicalFile().isFile() ) )
+ if ( ( !new File( javaHome ).getCanonicalFile().exists() )
+ || ( new File( javaHome ).getCanonicalFile().isFile() ) )
{
- throw new IOException(
- "The environment variable JAVA_HOME=" + javaHome + "
doesn't exist or is not a valid directory." );
+ throw new IOException( "The environment variable JAVA_HOME=" +
javaHome
+ + " doesn't exist or is not a valid directory." );
}
javadocExe = new File( javaHome + File.separator + "bin",
javadocCommand );
@@ -3580,7 +3634,7 @@ public abstract class AbstractJavadocMoj
if ( !javadocExe.getCanonicalFile().exists() ||
!javadocExe.getCanonicalFile().isFile() )
{
throw new IOException( "The javadoc executable '" + javadocExe
- + "' doesn't exist or is not a file.
Verify the JAVA_HOME environment variable." );
+ + "' doesn't exist or is not a file. Verify the JAVA_HOME
environment variable." );
}
return javadocExe.getAbsolutePath();
@@ -4222,7 +4276,7 @@ public abstract class AbstractJavadocMoj
currentSourcePath += "/";
}
- if (currentFile.contains(currentSourcePath))
+ if ( currentFile.contains( currentSourcePath ) )
{
String packagename = currentFile.substring(
currentSourcePath.length() + 1 );
@@ -4230,7 +4284,7 @@ public abstract class AbstractJavadocMoj
* Remove the miscellaneous files
*
http://docs.oracle.com/javase/1.4.2/docs/tooldocs/solaris/javadoc.html#unprocessed
*/
- if (packagename.contains("doc-files"))
+ if ( packagename.contains( "doc-files" ) )
{
continue;
}
@@ -4274,7 +4328,8 @@ public abstract class AbstractJavadocMoj
File optionsFile = new File( javadocOutputDirectory, OPTIONS_FILE_NAME
);
StringBuilder options = new StringBuilder();
- options.append( StringUtils.join(arguments.toArray(new
String[arguments.size()]), SystemUtils.LINE_SEPARATOR ) );
+ options.append( StringUtils.join( arguments.toArray( new
String[arguments.size()] ),
+ SystemUtils.LINE_SEPARATOR ) );
try
{
@@ -4853,14 +4908,19 @@ public abstract class AbstractJavadocMoj
return;
}
- for (Taglet taglet1 : taglets) {
- if ((taglet1 == null) ||
(StringUtils.isEmpty(taglet1.getTagletClass()))) {
- if (getLog().isWarnEnabled()) {
- getLog().warn("A taglet option is empty. Ignore this
option.");
- }
- } else {
- addArgIfNotEmpty(arguments, "-taglet",
JavadocUtil.quotedArgument(taglet1.getTagletClass()),
- SINCE_JAVADOC_1_4);
+ for ( Taglet taglet1 : taglets )
+ {
+ if ( ( taglet1 == null ) || ( StringUtils.isEmpty(
taglet1.getTagletClass() ) ) )
+ {
+ if ( getLog().isWarnEnabled() )
+ {
+ getLog().warn( "A taglet option is empty. Ignore this
option." );
+ }
+ }
+ else
+ {
+ addArgIfNotEmpty( arguments, "-taglet",
JavadocUtil.quotedArgument( taglet1.getTagletClass() ),
+ SINCE_JAVADOC_1_4 );
}
}
}
@@ -5048,11 +5108,14 @@ public abstract class AbstractJavadocMoj
}
writeDebugJavadocScript( cmdLine, javadocOutputDirectory );
- if ( StringUtils.isNotEmpty( output ) && StringUtils.isEmpty(
err.getOutput() ) && isJavadocVMInitError(
- output ) )
+ if ( StringUtils.isNotEmpty( output ) && StringUtils.isEmpty(
err.getOutput() )
+ && isJavadocVMInitError( output ) )
{
-
- throw new MavenReportException(output + '\n' + '\n' +
JavadocUtil.ERROR_INIT_VM + '\n' + "Or, try to reduce the Java heap size for
the Javadoc goal using " + "-Dminmemory=<size> and -Dmaxmemory=<size>." + '\n'
+ '\n' + "Command line was: " + cmdLine + '\n' + '\n' + "Refer to the generated
Javadoc files in '" + javadocOutputDirectory + "' dir.\n");
+ throw new MavenReportException( output + '\n' + '\n' +
JavadocUtil.ERROR_INIT_VM + '\n'
+ + "Or, try to reduce the Java heap size for the
Javadoc goal using "
+ + "-Dminmemory=<size> and -Dmaxmemory=<size>." + '\n'
+ '\n' + "Command line was: " + cmdLine
+ + '\n' + '\n' + "Refer to the generated Javadoc files
in '" + javadocOutputDirectory
+ + "' dir.\n" );
}
if ( StringUtils.isNotEmpty( output ) )
@@ -5069,8 +5132,8 @@ public abstract class AbstractJavadocMoj
msg.append( '\n' );
msg.append( "Command line was: " ).append( cmdLine ).append(
'\n' ).append( '\n' );
- msg.append( "Refer to the generated Javadoc files in '"
).append( javadocOutputDirectory ).append(
- "' dir.\n" );
+ msg.append( "Refer to the generated Javadoc files in '"
).append( javadocOutputDirectory )
+ .append( "' dir.\n" );
throw new MavenReportException( msg.toString() );
}
@@ -5161,8 +5224,8 @@ public abstract class AbstractJavadocMoj
/**
* @param outputFile not nul
- * @param inputResourceName a not null resource in
<code>src/main/java</code>, <code>src/main/resources</code> or
<code>src/main/javadoc</code>
- * or in the Javadoc plugin dependencies.
+ * @param inputResourceName a not null resource in
<code>src/main/java</code>, <code>src/main/resources</code> or
+ * <code>src/main/javadoc</code> or in the
Javadoc plugin dependencies.
* @return the resource file absolute path as String
* @since 2.6
*/
@@ -5279,7 +5342,7 @@ public abstract class AbstractJavadocMoj
}
}
- ClassLoader javadocClassLoader = new URLClassLoader(urls.toArray( new
URL[urls.size()] ), null );
+ ClassLoader javadocClassLoader = new URLClassLoader( urls.toArray( new
URL[urls.size()] ), null );
return javadocClassLoader.getResource( resource );
}
@@ -5497,7 +5560,8 @@ public abstract class AbstractJavadocMoj
/**
* @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>
+ * 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.
* @see #detectJavaApiLink
@@ -5536,6 +5600,7 @@ public abstract class AbstractJavadocMoj
+ fJavadocVersion );
}
+ // CHECKSTYLE_OFF: MagicNumber
String apiVersion = null;
if ( sourceVersion >= 1.3f && sourceVersion < 1.4f )
{
@@ -5562,6 +5627,7 @@ public abstract class AbstractJavadocMoj
apiVersion = "1.8";
}
String javaApiLink = javaApiLinks.getProperty( "api_" + apiVersion,
null );
+ // CHECKSTYLE_ON: MagicNumber
if ( getLog().isDebugEnabled() )
{
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/FixJavadocMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/FixJavadocMojo.java?rev=1642248&r1=1642247&r2=1642248&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/FixJavadocMojo.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/FixJavadocMojo.java
Fri Nov 28 00:10:50 2014
@@ -26,7 +26,8 @@ import org.apache.maven.plugins.annotati
/**
* Fix Javadoc documentation and tags for the <code>Java code</code> for the
project.
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#wheretags";>Where
Tags Can Be Used</a>.
+ * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#wheretags";>Where
Tags Can
+ * Be Used</a>.
*
* @author <a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</a>
* @version $Id$
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java?rev=1642248&r1=1642247&r2=1642248&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java
Fri Nov 28 00:10:50 2014
@@ -49,7 +49,8 @@ import java.util.Locale;
* @version $Id$
* @since 2.0
*/
-@Mojo( name = "jar", defaultPhase = LifecyclePhase.PACKAGE,
requiresDependencyResolution = ResolutionScope.COMPILE, threadSafe = true )
+@Mojo( name = "jar", defaultPhase = LifecyclePhase.PACKAGE,
requiresDependencyResolution = ResolutionScope.COMPILE,
+ threadSafe = true )
public class JavadocJar
extends AbstractJavadocMojo
{
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocNoForkReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocNoForkReport.java?rev=1642248&r1=1642247&r2=1642248&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocNoForkReport.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocNoForkReport.java
Fri Nov 28 00:10:50 2014
@@ -38,5 +38,6 @@ import org.apache.maven.plugins.annotati
@Mojo( name = "javadoc-no-fork", requiresDependencyResolution =
ResolutionScope.COMPILE, threadSafe = true )
@Execute( phase = LifecyclePhase.NONE )
public class JavadocNoForkReport
- extends JavadocReport {
+ extends JavadocReport
+{
}
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=1642248&r1=1642247&r2=1642248&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
Fri Nov 28 00:10:50 2014
@@ -196,9 +196,10 @@ public class JavadocUtil
List<String> excludedNames = new ArrayList<String>();
for ( String path : sourcePaths )
{
- for (String aSubpackagesList : subpackagesList) {
- List<String> excludes = getExcludedPackages(path,
excludedPackages);
- excludedNames.addAll(excludes);
+ for ( String aSubpackagesList : subpackagesList )
+ {
+ List<String> excludes = getExcludedPackages( path,
excludedPackages );
+ excludedNames.addAll( excludes );
}
}
@@ -271,7 +272,7 @@ public class JavadocUtil
if ( StringUtils.isNotEmpty( arg ) )
{
- if (arg.contains("'"))
+ if ( arg.contains( "'" ) )
{
arg = StringUtils.replace( arg, "'", "\\'" );
}
@@ -298,7 +299,7 @@ public class JavadocUtil
if ( StringUtils.isNotEmpty( path ) )
{
path = path.replace( '\\', '/' );
- if (path.contains("\'"))
+ if ( path.contains( "\'" ) )
{
String split[] = path.split( "\'" );
path = "";
@@ -408,46 +409,62 @@ public class JavadocUtil
{
List<String> files = new ArrayList<String>();
- for (String aFileList : fileList) {
+ for ( String aFileList : fileList )
+ {
boolean include = true;
- for (int k = 0; k < excludePackages.length && include; k++) {
+ for ( int k = 0; k < excludePackages.length && include; k++ )
+ {
// handle wildcards (*) in the excludePackageNames
- String[] excludeName = excludePackages[k].split("[*]");
+ String[] excludeName = excludePackages[k].split( "[*]" );
- if (excludeName.length == 0) {
+ if ( excludeName.length == 0 )
+ {
continue;
}
- if (excludeName.length > 1) {
+ if ( excludeName.length > 1 )
+ {
int u = 0;
- while (include && u < excludeName.length) {
- if (!"".equals(excludeName[u].trim()) &&
aFileList.contains(excludeName[u])) {
+ while ( include && u < excludeName.length )
+ {
+ if ( !"".equals( excludeName[u].trim() ) &&
aFileList.contains( excludeName[u] ) )
+ {
include = false;
}
u++;
}
- } else {
- if (aFileList.startsWith(sourceDirectory.toString() +
File.separatorChar + excludeName[0])) {
- if
(excludeName[0].endsWith(String.valueOf(File.separatorChar))) {
- int i = aFileList.lastIndexOf(File.separatorChar);
- String packageName = aFileList.substring(0, i + 1);
- File currentPackage = new File(packageName);
- File excludedPackage = new File(sourceDirectory,
excludeName[0]);
- if (currentPackage.equals(excludedPackage)
- &&
aFileList.substring(i).contains(".java")) {
+ }
+ else
+ {
+ if ( aFileList.startsWith( sourceDirectory.toString() +
File.separatorChar + excludeName[0] ) )
+ {
+ if ( excludeName[0].endsWith( String.valueOf(
File.separatorChar ) ) )
+ {
+ int i = aFileList.lastIndexOf( File.separatorChar
);
+ String packageName = aFileList.substring( 0, i + 1
);
+ File currentPackage = new File( packageName );
+ File excludedPackage = new File( sourceDirectory,
excludeName[0] );
+ if ( currentPackage.equals( excludedPackage )
+ && aFileList.substring( i ).contains( ".java"
) )
+ {
include = true;
- } else {
+ }
+ else
+ {
include = false;
}
- } else {
+ }
+ else
+ {
include = false;
}
}
}
}
- if (include) {
- files.add(quotedPathArgument(aFileList));
+ if ( include )
+ {
+ files.add( quotedPathArgument( aFileList ) );
}
}
@@ -465,15 +482,19 @@ public class JavadocUtil
protected static List<String> getExcludedPackages( String sourceDirectory,
String[] excludePackagenames )
{
List<String> files = new ArrayList<String>();
- for (String excludePackagename : excludePackagenames) {
- String[] fileList =
FileUtils.getFilesFromExtension(sourceDirectory, new String[]{"java"});
- for (String aFileList : fileList) {
- String[] excludeName = excludePackagename.split("[*]");
+ for ( String excludePackagename : excludePackagenames )
+ {
+ String[] fileList = FileUtils.getFilesFromExtension(
sourceDirectory, new String[] { "java" } );
+ for ( String aFileList : fileList )
+ {
+ String[] excludeName = excludePackagename.split( "[*]" );
int u = 0;
- while (u < excludeName.length) {
- if (!"".equals(excludeName[u].trim()) &&
aFileList.contains(excludeName[u])
- && !sourceDirectory.contains(excludeName[u])) {
- files.add(aFileList);
+ while ( u < excludeName.length )
+ {
+ if ( !"".equals( excludeName[u].trim() ) &&
aFileList.contains( excludeName[u] )
+ && !sourceDirectory.contains( excludeName[u] ) )
+ {
+ files.add( aFileList );
}
u++;
}
@@ -527,7 +548,7 @@ public class JavadocUtil
String[] pathList = new String[fileList.length];
for ( int x = 0; x < fileList.length; x++ )
{
- pathList[x] = new File( sourceDirectory, fileList[x]
).getAbsolutePath( );
+ pathList[x] = new File( sourceDirectory, fileList[x]
).getAbsolutePath();
}
@@ -553,7 +574,8 @@ public class JavadocUtil
* @see #parseJavadocVersion(String)
*/
protected static float getJavadocVersion( File javadocExe )
- throws IOException, CommandLineException, IllegalArgumentException {
+ throws IOException, CommandLineException, IllegalArgumentException
+ {
if ( ( javadocExe == null ) || ( !javadocExe.exists() ) || (
!javadocExe.isFile() ) )
{
throw new IOException( "The javadoc executable '" + javadocExe +
"' doesn't exist or is not a file. " );
@@ -631,7 +653,8 @@ public class JavadocUtil
* @throws IllegalArgumentException if the output is null
*/
protected static float parseJavadocVersion( String output )
- throws IllegalArgumentException {
+ throws IllegalArgumentException
+ {
if ( StringUtils.isEmpty( output ) )
{
throw new IllegalArgumentException( "The output could not be
null." );
@@ -986,8 +1009,9 @@ public class JavadocUtil
String invokerLogContent = readFile( invokerLog, "UTF-8" );
// see DefaultMaven
- if ( invokerLogContent != null &&
(!invokerLogContent.contains("Scanning for projects...")
- ||
invokerLogContent.contains(OutOfMemoryError.class.getName())) )
+ if ( invokerLogContent != null
+ && ( !invokerLogContent.contains( "Scanning for projects..." )
+ || invokerLogContent.contains(
OutOfMemoryError.class.getName() ) ) )
{
if ( log != null )
{
@@ -1007,8 +1031,9 @@ public class JavadocUtil
String invokerLogContent = readFile( invokerLog, "UTF-8" );
// see DefaultMaven
- if ( invokerLogContent != null &&
(!invokerLogContent.contains("Scanning for projects...")
- ||
invokerLogContent.contains(OutOfMemoryError.class.getName())) )
+ if ( invokerLogContent != null
+ && ( !invokerLogContent.contains( "Scanning for projects..." )
+ || invokerLogContent.contains(
OutOfMemoryError.class.getName() ) ) )
{
throw new MavenInvocationException( ERROR_INIT_VM );
}
@@ -1800,15 +1825,15 @@ public class JavadocUtil
if ( StringUtils.isNotEmpty( activeProxy.getHost() )
&& ( url == null || !ProxyUtils.validateNonProxyHosts(
proxyInfo, url.getHost() ) ) )
{
- HttpHost proxy = new HttpHost(activeProxy.getHost(),
activeProxy.getPort());
-
httpClient.getParams().setParameter(ConnRoutePNames.DEFAULT_PROXY, proxy);
+ HttpHost proxy = new HttpHost( activeProxy.getHost(),
activeProxy.getPort() );
+ httpClient.getParams().setParameter(
ConnRoutePNames.DEFAULT_PROXY, proxy );
if ( StringUtils.isNotEmpty( activeProxy.getUsername() ) &&
activeProxy.getPassword() != null )
{
Credentials credentials =
new UsernamePasswordCredentials(
activeProxy.getUsername(), activeProxy.getPassword() );
-
httpClient.getCredentialsProvider().setCredentials(AuthScope.ANY, credentials);
+ httpClient.getCredentialsProvider().setCredentials(
AuthScope.ANY, credentials );
}
}
}
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java?rev=1642248&r1=1642247&r2=1642248&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java
Fri Nov 28 00:10:50 2014
@@ -21,7 +21,6 @@ package org.apache.maven.plugin.javadoc;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
-import org.apache.maven.plugin.javadoc.options.JavadocOptions;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
@@ -76,7 +75,8 @@ extends AbstractJavadocMojo
private ArchiverManager archiverManager;
/**
- * Assemble a new {@link JavadocOptions} instance that contains the
configuration options in this
+ * Assemble a new {@link
org.apache.maven.plugin.javadoc.options.JavadocOptions JavadocOptions} instance
that
+ * contains the configuration options in this
* mojo, which are a subset of those provided in derivatives of the {@link
AbstractJavadocMojo}
* class (most of the javadoc mojos, in other words). Then, bundle the
contents of the
* <code>javadocDirectory</code> along with the assembled JavadocOptions
instance (serialized to
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestFixJavadocMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestFixJavadocMojo.java?rev=1642248&r1=1642247&r2=1642248&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestFixJavadocMojo.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestFixJavadocMojo.java
Fri Nov 28 00:10:50 2014
@@ -34,13 +34,14 @@ import java.util.List;
/**
* Fix Javadoc documentation and tags for the <code>Test Java code</code> for
the project.
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#wheretags";>Where
Tags Can Be Used</a>.
+ * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#wheretags";>Where
Tags Can
+ * Be Used</a>.
*
* @author <a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</a>
* @version $Id$
* @since 2.6
*/
-@Mojo( name = "test-fix", requiresDependencyResolution = ResolutionScope.TEST,
threadSafe = true)
+@Mojo( name = "test-fix", requiresDependencyResolution = ResolutionScope.TEST,
threadSafe = true )
@Execute( phase = LifecyclePhase.TEST_COMPILE )
public class TestFixJavadocMojo
extends AbstractFixJavadocMojo
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocJar.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocJar.java?rev=1642248&r1=1642247&r2=1642248&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocJar.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocJar.java
Fri Nov 28 00:10:50 2014
@@ -42,7 +42,8 @@ import java.util.List;
* @version $Id$
* @since 2.5
*/
-@Mojo( name = "test-jar", defaultPhase = LifecyclePhase.PACKAGE,
requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true)
+@Mojo( name = "test-jar", defaultPhase = LifecyclePhase.PACKAGE,
requiresDependencyResolution = ResolutionScope.TEST,
+ threadSafe = true )
public class TestJavadocJar
extends JavadocJar
{
@@ -87,7 +88,8 @@ public class TestJavadocJar
/**
* Specifies the Test title to be placed in the HTML title tag.
* <br/>
- * See <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#windowtitle";>windowtitle</a>.
+ * See
+ * <a
href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#windowtitle";>windowtitle</a>.
* <br/>
*
* @since 2.5
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocNoForkReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocNoForkReport.java?rev=1642248&r1=1642247&r2=1642248&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocNoForkReport.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocNoForkReport.java
Fri Nov 28 00:10:50 2014
@@ -36,7 +36,7 @@ import org.apache.maven.plugins.annotati
* @see <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/";>Javadoc
Tool</a>
* @see <a
href="http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options";>Javadoc
Options </a>
*/
-@Mojo( name = "test-javadoc-no-fork", requiresDependencyResolution =
ResolutionScope.TEST, threadSafe = true)
+@Mojo( name = "test-javadoc-no-fork", requiresDependencyResolution =
ResolutionScope.TEST, threadSafe = true )
@Execute( phase = LifecyclePhase.NONE )
public class TestJavadocNoForkReport
extends TestJavadocReport
