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

stddoclet: support @link tags in user's html files in doc-files directory

    XMLWordPrintable

    Details

    • Type: Enhancement
    • Status: Resolved
    • Priority: P4
    • Resolution: Fixed
    • Affects Version/s: 1.4.2
    • Fix Version/s: 10
    • Component/s: tools

      Description



      Name: rmT116609 Date: 11/03/2003


      A DESCRIPTION OF THE REQUEST :
      I'd like to split overview.html and package.html files into several .html files (because there is way too much info for one .html file). I can put these .html files into doc-files and link to them, but inside these files I cannot use @link tags to refer to classes. This is really annoying, and is forcing me to dump unmanageably large amounts of info into overview.html and package.html files.


      JUSTIFICATION :
      Often there are "concepts" that are used throughout a system, and that do not belong under any specific JavaDoc element. Ideally I'd be able to document these concepts in separate .html files, and reference them from JavaDoc comments. I can do that by putting these files under doc-files/ directories -- but inside these files I cannot use @link tags, which is a real hindrance.


      EXPECTED VERSUS ACTUAL BEHAVIOR :
      EXPECTED -
      When copying doc-files/ files to the documentation output directory, the @link tags in .html files should be replaced with the correct hyperlinks.
      (Incident Review ID: 223219)
      ======================================================================

        Attachments

          Activity

            People

            Assignee:
            ksrini Kumar Srinivasan
            Reporter:
            rmandalasunw Ranjith Mandala (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: