JDK-4278898 : Some warning messages do not mention class name where warning exists
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.2.0
  • Priority: P4
  • Status: Closed
  • Resolution: Duplicate
  • OS: solaris_2.6
  • CPU: sparc
  • Submitted: 1999-10-06
  • Updated: 2002-06-27
  • Resolved: 2001-03-06
Related Reports
Duplicate :  
Description
Warning messages are inconsistent in Javadoc and doclets.

Many warning messages that Javadoc emits properly show the fully qualified
name of the member where the problem exists:

   Warning: java.awt.Scrollbar.Scrollbar(): Unsupported HTML tag 
   in documentation comment "</table>"

However not all messages do this.  For example:

   Warning: Tag @see: Class or Package not found: java.awtScrollbar#setValues

Also, some begin with "warning" (above), while others begin with "javadoc":

   javadoc: warning - java.awt.SystemColor.getRGB(): Tag @see: can't find 
   getBlue(int) in java.awt.Color

It would be easier to scan down the list if they were consistent.
If it makes the line too long to include the fully-qualified class name,
then at least give the raw class name.

Comments
SUGGESTED FIX Suggest using this form for all messages: Warning: <fullyQualifiedName>: [ Tag <tagname>: ] <warningmessage> Examples: Warning: java.awt.Scrollbar.Scrollbar(): Unsupported HTML tag in documentation comment "</table>" Warning: java.awt.Scrollbar.Scrollbar(): Tag @see: Class or Package not found: java.awtScrollbar#setValues Warning: java.awt.SystemColor.getRGB(): Tag @see: can't find getBlue(int) in java.awt.Color
11-06-2004

PUBLIC COMMENTS .
10-06-2004