Maven Javadoc Plugin
  1. Maven Javadoc Plugin
  2. MJAVADOC-28

{@link foo} doesn't work when "foo" is a package name

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.0
    • Labels:
      None
    • Environment:
      Windows XP

      Description

      See or link tags of the kind

      {@link org.mypackage}

      doesn't work with maven-javadoc-plugin (we get a "Tag @link: reference not found: org.mypackage" warning), while it work when using the javadoc tool from the command line or from an Ant script. I suspect that this is related to the way maven-javadoc-plugin work, which provides a list of source files as a @files argument.

      A possible workaround is to provide a way to use the maven-javadoc-plugin through the javadoc's -subpackages option, instead of letting maven-javadoc-plugin creates a @files. It would gives more control to the user, would allows the current <excludePackageNames> parameter to work (this parameter is currently useless since it is ignored when the files to process are provided in @files), and would solve the problem reported in this JIRA issue.

      1. MJAVADOC-28-maven-javadoc-plugin.patch
        13 kB
        Maria Odea Ching
      2. test.zip
        4 kB
        Martin Desruisseaux

        Activity

          People

          • Assignee:
            Maria Odea Ching
            Reporter:
            Martin Desruisseaux
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - Not Specified
              Not Specified
              Remaining:
              Remaining Estimate - 0h
              0h
              Logged:
              Time Spent - 10.5h
              10.5h

                Development