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: 4217345
Votes 2
Synopsis stddoclet: -quiet option to shut off non-error processing/generating messages
Category doclet:tbd
Reported Against 1.2 , merlin-beta
Release Fixed 1.4(merlin-beta2)
State 10-Fix Delivered, Verified, request for enhancement
Priority: 4-Low
Related Bugs 4431712
Submit Date 04-MAR-1999
Description
Added -quiet option to shut off non-error/warning noise.
 xxxxx@xxxxx  2001-05-09

JavaDoc needs a '-quiet' option to shut off the noise msgs.

The "processing" and "generating" output msgs are currently
uncontrollable, and make it difficult to find the warnings 
and errors.
(Review ID: 55083) 
======================================================================
Work Around
N/A
Evaluation
Added -quiet option to shut off non-error/warning noise.

Location of fix:
standard.properties
ConfigurationStandard.java
MessageRetriever.java

 xxxxx@xxxxx  2001-05-09

We need to decide on this.
 xxxxx@xxxxx  1999-03-16

I believe this requires changes to both the javadoc tool and the standard doclet.
 xxxxx@xxxxx  2000-12-06

We need to decide whether to break "compatibility" and offer a new 
option, such as -quiet (suggested by an outside developer), 
or modify -verbose so the default is not to show those "processing" 
and "generating" messages.    Only the -quiet option would maintain
compatibility, but would be different from javac, which is quiet
by default.  (I notice that javac displays no parsing/loading/writing
messages without -verbose, but with -verbose displays them with millisec.)

There is a lot of value in the current default messages, as it
shows the status/progress of javadoc.  I would not want these messages
to be merged with the current -verbose messages (for the following
reasons).  We may need two levels of verbose, which is achieved
with either -quiet or by adding a variant of -verbose.

The first disadvantage to the current -verbose is that it seems to 
take 30 seconds before the first message is displayed, compared to 
2 seconds without -verbose.  It's doing something up-front.
Secondly, -verbose currently adds messages showing each .class 
file it loads and how many millisecs it takes to load each one.
When documenting the simple com.package1 and com.package2 sample packages,
this ends up with 72 messages compared to 23 messages without -verbose.
Here are the kinds of messages -verbose displays:
  Loading source files for package com.package1...
  [parsed ./test/sample-src/com/package1/Interface1.java in 423 ms]
  [parsed ./test/sample-src/com/package1/SubClass1.java in 97 ms]
  [parsed ./test/sample-src/com/package1/Class1.java in 26 ms]

  Constructing Javadoc information...
  [loaded /net/koori.eng/a/v06/jdk/1.3.0_solaris/fcs/binaries/solaris/jre/lib/
  rt.jar(java/lang/Object.class) in 28 ms]

So we should not simply move the "processing" and "generating" messages 
to -verbose. 

 xxxxx@xxxxx  2001-03-29
Comments
  
  Include a link with my name & email   

Submitted On 27-OCT-1999
djd
You can quiet most of the messages by providing a doclet that calls the
standard or OneOne doclet with a RootDoc implementation that taks the real
RootDoc and forwards every call except the printNotice. A -quiet option would
be much netter though.



PLEASE NOTE: JDK6 is formerly known as Project Mustang