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

Many bad JavaDoc tags and breakiterator issues in core library documentation

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P4
    • Resolution: Duplicate
    • Affects Version/s: 1.4.2
    • Fix Version/s: None
    • Component/s: docs
    • Labels:
      None
    • Subcomponent:
    • CPU:
      generic
    • OS:
      generic

      Description

      During a build of the j2se workspace coredocs target, many JavaDoc warnings are generated due to malformed JavaDoc source, such as bad tags. These problems should be corrected. The types of problems include:

      * @link and @see tags with bad targets (see bad-links.list in attachment tar ball)

      * Unknown tags: these fall into two categories,
        * misspelled tags (e.g. "@parm", "@returns", "@throw")
        * known tags being used for other purposes (e.g. "@beaninfo")

        The former should be fixed. For the latter, especially @beaninfo, the JavaDoc build should include the appropriate -tag foo:X options to JavaDoc to avoid the spurious warnings. (See unknown-tag.list in attachment tar ball.)

      Another class of common warnings in the build is breakiterator differences which lead to numerous voluminous warnings being issued. These discrepancies should be investigated and resolved.

      Ideally, the docs target should build without any warnings. The large number of warnings makes finding newly introduced warnings difficult.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              shommel Scott Hommel (Inactive)
              Reporter:
              darcy Joe Darcy
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: