Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4702454
Votes 1
Synopsis tool: -quiet should suppress non-error/warning messages in javadoc tool
Category java:javadoctool
Reported Against hopper
Release Fixed 1.5(tiger-b40)
State 10-Fix Delivered, request for enhancement
Priority: 4-Low
Related Bugs
Submit Date 14-JUN-2002
Description
Why am I getting the first two lines when I run javadoc -quiet:

Loading source file Access.java...
Constructing Javadoc information...
.\Client.java:11: '.' expected
import Server;
             ^
1 error

==========================================================
-quiet just isn't useful (to me, at least), unless it actually 
prevents *all* non-error/warning messages.  The idea is to be 
totally silent unless there is a problem -
that way, an output scraping script (for instance) can tell if the run
was clean (or not).  Without a functionally quiet behavior, such a
script is required to actually parse the output line-by-line to decide
if it is something a human needs to see.  In my case, we build several
branches of a 1MLOC application on an hourly basis continuously - it is
*really* important that the build results analysis tool not complain
about false positives.  Any such long-term leaks end up with the
developers ignoring the messages and thus missing real problems...
Work Around
N/A
Evaluation
Because that is an option to the standard doclet.  The standard doclet
is not printing those messages, the tool is.

Part of the problem is the documentation for the -quiet option, which
implies that it would suppress messages from the tool, which it cannot.

This is not a bug, though perhaps a reasonable feature request.

 xxxxx@xxxxx  2002-06-14

Related bugs are:
   4714350 where the documentation incorrectly states that all messages are 
           suppressed (which will be true once this bug is fixed)
   4431712 an obsolete proposal to move messages to the -verbose option

When neither -verbose nor -quiet are specified, the behavior should be
unchanged from its current behavior.  When both are specified, I suggest
we throw an error and do not continue, with an error message such as:

   error: cannot continue with both options: -verbose -quiet

 xxxxx@xxxxx  2002-07-25
Comments
  
  Include a link with my name & email   

Submitted On 28-MAY-2003
erik_nolte
A fragile (implementation specific) hack is to add the
following method to your custom doclet.

   public static boolean validOptions(
       String[][]       options,
       DocErrorReporter reporter
       )
   {
       ( (Messager) reporter).noticeWriter.close();

       return true;
   }


Submitted On 22-DEC-2003
Peenie
The javadoc tool *does* return 0 to the system on success 
and non-zero on error... you could always just check that from 
a script.



PLEASE NOTE: JDK6 is formerly known as Project Mustang