Issue Details (XML | Word | Printable)

Key: MJAVADOC-188
Type: Bug Bug
Status: Closed Closed
Resolution: Fixed
Priority: Trivial Trivial
Assignee: Vincent Siveton
Reporter: Cleber Zarate
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
Maven 2.x Javadoc Plugin

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

Created: 16/May/08 04:52 PM   Updated: 17/May/08 09:16 AM   Resolved: 17/May/08 09:16 AM
Return to search
Component/s: None
Affects Version/s: 2.4
Fix Version/s: 2.5

Time Tracking:
Not Specified

Environment: jdk 1.5


 Description  « Hide

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



Vincent Siveton made changes - 17/May/08 08:43 AM
Field Original Value New Value
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
The -top argument is being passed when we're using a version smaller than 1.6.
Then the following warning is generated:
{noformat}
"[WARNING] -top option is not supported on Java version < 1.6. Ignore this option."
{noformat}

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:
{noformat}
addArgIfNotEmpty( arguments, "-top", JavadocUtil.quotedArgument( top ), false, false, SINCE_JAVADOC_1_6 );
{noformat}

however, this method checks the version first, and then checks if the argument is null, like the following:
{noformat}
      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." );
            }
        }
}}
{noformat}

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
Vincent Siveton made changes - 17/May/08 09:14 AM
Affects Version/s 2.4 [ 13630 ]
Vincent Siveton added a comment - 17/May/08 09:16 AM

fixed in r657363, snapshot 2.5 deployed


Vincent Siveton made changes - 17/May/08 09:16 AM
Assignee Vincent Siveton [ siveton ]
Resolution Fixed [ 1 ]
Fix Version/s 2.5 [ 14120 ]
Status Open [ 1 ] Closed [ 6 ]