JDK-4745901 : Many bad JavaDoc tags and breakiterator issues in core library documentation
  • Type: Bug
  • Component: docs
  • Sub-Component: guides
  • Affected Version: 1.4.2
  • Priority: P4
  • Status: Closed
  • Resolution: Duplicate
  • OS: generic
  • CPU: generic
  • Submitted: 2002-09-11
  • Updated: 2002-10-24
  • Resolved: 2002-10-24
Related Reports
Duplicate :  
Relates :  
Relates :  
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.

Comments
EVALUATION Related bugs: 4492953 Fix first sentences that emit new warnings due to -breakiterator change 4655855 Resolve unknown tags in javadoc warnings for J2SE 1.4.0 4655858 Remove warnings for @beaninfo, @revised and @spec as unknown tags in javadoc
11-06-2004