Maven 2.x Javadoc Plugin

-top command line argument is passed even when java version is <1.6, generating a warning

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Trivial Trivial
  • Resolution: Fixed
  • Affects Version/s: 2.4
  • Fix Version/s: 2.5
  • Component/s: None
  • Labels:
    None
  • Environment:
    jdk 1.5
  • Number of attachments :
    0

Description

The -top argument is being passed when we're using a version smaller than 1.6.
Then the following warning is generated:

"[WARNING] -top option is not supported on Java version < 1.6. Ignore this option."

This warning shouldn't be thrown since we're not setting the -top parameter in the POM, so there's no way to ignore it.
On AbstractJavadocMojo.java, line 1492, the following method is called:

addArgIfNotEmpty( arguments, "-top", JavadocUtil.quotedArgument( top ), false, false, SINCE_JAVADOC_1_6 );

however, this method checks the version first, and then checks if the argument is null, like the following:

      if ( isJavaDocVersionAtLeast( requiredJavaVersion ) ) 
        {
            addArgIfNotEmpty( arguments, key, value, repeatKey, splitValue );
        }
        else
        {
            if ( getLog().isWarnEnabled() )
            {
                getLog().warn( key + " option is not supported on Java version < " + requiredJavaVersion
                               + ". Ignore this option." );
            }
        }
}}

Specifically for this command line argument, the method should check the version before calling addArgIfNotEmpty, thus removing the warning if we're not explicitly passing the argument in a jdk < 1.6

Activity

Hide
Vincent Siveton added a comment -

fixed in r657363, snapshot 2.5 deployed

Show
Vincent Siveton added a comment - fixed in r657363, snapshot 2.5 deployed

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: