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

Doclet API: Clarifying "qualified name"

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Won't Fix
    • Icon: P4 P4
    • 9
    • 1.4.0
    • tools



      Name: eaC66865 Date: 12/06/2002


      Doc.name() says: "Returns the unqualified name".
      So when you are using PackageDoc, you go looking for the qualified name,

      but there isn't any.

      The docs can help to eliminate the confusion in two places:
        1. At the end package.html's terminology section, add a note:
              "There is no such thing as qualified or unqualified package
      name.
                Package names always consist of the complete package path."

        2. Modify Doc.name() to say:
            Returns the "name" of the Doc object, where:
               a) The name of the package consists of the complete
      package-path
               b) The name of any other Doc object is it's unqualified name.

      Examples here or in the terminology section would also be useful:
             package foo.bar
                  -- name: foo.bar

             class foo.bar.Baz
                  -- name: Baz
                  -- qualifiedName: foo.bar.Baz

             nested class foo.bar.Baz.Inner
                  -- name: Baz.Inner
                  -- qualifiedName: foo.bar.Baz.Inner

      ======================================================================

            ksrini Kumar Srinivasan
            earmstrosunw Eric Armstrong (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: