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

stddoclet: Add ability to jump/link to user anchor on class/package page w/o giving filename

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Unresolved
    • P4
    • None
    • 1.4.0
    • tools

    Description

      Name: dk30142 Date: 10/04/2002

      Currently, if you want to jump to a named anchor on a package or class page,
      you must hard-code the filename, as with this method in interface
      com.sun.javadoc.PackageDoc that jumps to a package page:

          /**
           * Get all classes (including Exceptions and Errors) and interfaces,
           * filtered to the specified
           * <a href="package-summary.html#terminology">access modifier option</a>.
           */
          ClassDoc[] allClasses(boolean filter);

      It seems odd to have to supply a filename, as this is not required when
      jumping to a program element.

      It would seem to be useful to be able to use a named anchor where you'd
      expect to supply a program element:

      for a package:
           {@link com.sun.javadoc#terminology access modifier option}

      for a class:
           {@link com.sun.javadoc.Doc#terminology access modifier option}

      I have no idea how this might present a problem, mixing named anchors with
      program elements.

      FYI, for this example, the named anchor is this:

      <a name="terminology"></a>
      <h3>Terminology</h3>

      When calling javadoc, you pass in package names and source file names
      (along with command line options). The <em>access control</em> options
      (<code>-public</code>, <code>-protected</code>, <code>-package</code>,
      and <code>-private</code>) filter out some of the program elements.

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

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              dkramersunw Douglas Kramer (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Imported:
                Indexed: