Maven 2.x Javadoc Plugin

javadoc:fix mojo should fully qualify {@link} class names

Details

  • Type: New Feature New Feature
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 2.6
  • Fix Version/s: 2.8.1
  • Labels:
    None
  • Number of attachments :
    0

Description

When the javadoc:fix goal is executed, it rightly adds fully qualified class names for each

{@link} tag. It would be great if the mojo would fix existing {@link}

tags to be fully qualified, also. Thanks!

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Vincent Siveton added a comment -

I already thought about this feature but it seems difficult to find the right class in the classloader.

    /**
     * @throws ConnectException
     * @see {@link ConnectException}
     */
    public void dummy()
        throws ConnectException {}

    public static class ConnectException extends Exception{}

Which ConnectException? net, rmi or inner?

Show
Vincent Siveton added a comment - I already thought about this feature but it seems difficult to find the right class in the classloader. /** * @throws ConnectException * @see {@link ConnectException} */ public void dummy() throws ConnectException {} public static class ConnectException extends Exception{} Which ConnectException? net, rmi or inner?
Hide
Permalink
jieryn added a comment -

Does the m-javadoc-p have any class-level sense? By this I mean, if there were is an import statement for that class name, use it, otherwise, use $package.

Show
jieryn added a comment - Does the m-javadoc-p have any class-level sense? By this I mean, if there were is an import statement for that class name, use it, otherwise, use $package.
Hide
Permalink
Vincent Siveton added a comment -

Yes we could have the import list but in my sample, it does not guarantee the "exact" class to be throw.
If you have any ideas, please provide a patch.

Show
Vincent Siveton added a comment - Yes we could have the import list but in my sample, it does not guarantee the "exact" class to be throw. If you have any ideas, please provide a patch.
Hide
Permalink
Robert Scholte added a comment -

Fixed in rev. 1147437
The

{@link}

will be resolved for the comment and tags in the javadoc of the class, its methods and constructors.

Show
Robert Scholte added a comment - Fixed in rev. 1147437 The {@link} will be resolved for the comment and tags in the javadoc of the class, its methods and constructors.

People

  • Assignee:
    Robert Scholte
    Reporter:
    jieryn
Vote (1)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: