Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8031625

javadoc problems referencing inner class constructors

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P2
    • Resolution: Fixed
    • Affects Version/s: 8
    • Fix Version/s: 9
    • Component/s: tools
    • Labels:
    • Subcomponent:
    • Resolved In Build:
      b08
    • Verification:
      Verified

      Description

      Javadoc has problems with references to inner class constructors, such as Path2D.Float#Float(Shape, AffineTransform)

      I would expect to be able to write
          @see Path2D.Float#Float(Shape, AffineTransform)

      with the names Path2D, Shape and AffineTransform being resolved with imports (either explicit, or import-on-demand) and with .Float being resolved against Path2D and #Float being "resolved" as a constructor name.

      Instead, the nearest I can get to work is:
      @see java.awt.geom.Path2D.Float#Path2D.Float(java.awt.Shape, java.awt.geom.AffineTransform)

      i.e. fully qualified names, and #Path2D.Float, which is not a syntactically valid member name, so doclint complains.

      Filing as a P2 because this is preventing clean docs builds of JDK 8 and up.

        Activity

        Hide
        bpatel Bhavesh Patel added a comment -
        The @see tag does not handle the constructor of nested classes correctly. It tries to look for class qualified reference to the constructor. The HtmlDocletWriter.seeTagToContent() and SeeTagImpl.findExecutableMember() needs to be updated for javadoc to find the constructor of nested classes correctly when using a @see tag.
        Show
        bpatel Bhavesh Patel added a comment - The @see tag does not handle the constructor of nested classes correctly. It tries to look for class qualified reference to the constructor. The HtmlDocletWriter.seeTagToContent() and SeeTagImpl.findExecutableMember() needs to be updated for javadoc to find the constructor of nested classes correctly when using a @see tag.
        Hide
        hgupdate HG Updates added a comment -
        URL: http://hg.openjdk.java.net/jdk9/dev/langtools/rev/62256a27aaff
        User: bpatel
        Date: 2014-03-26 05:08:42 +0000
        Show
        hgupdate HG Updates added a comment - URL: http://hg.openjdk.java.net/jdk9/dev/langtools/rev/62256a27aaff User: bpatel Date: 2014-03-26 05:08:42 +0000
        Hide
        hgupdate HG Updates added a comment -
        URL: http://hg.openjdk.java.net/jdk9/jdk9/langtools/rev/62256a27aaff
        User: lana
        Date: 2014-04-09 18:27:58 +0000
        Show
        hgupdate HG Updates added a comment - URL: http://hg.openjdk.java.net/jdk9/jdk9/langtools/rev/62256a27aaff User: lana Date: 2014-04-09 18:27:58 +0000

          People

          • Assignee:
            bpatel Bhavesh Patel
            Reporter:
            jjg Jonathan Gibbons
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: