JDK-4217345 : stddoclet: -quiet option to shut off non-error processing/generating messages
  • Type: Enhancement
  • Status: Closed
  • Resolution: Fixed
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Priority: P4
  • Affected Version: 1.2.0,1.4.0
  • OS: generic
  • CPU: generic
  • Submit Date: 1999-03-04
  • Updated Date: 2014-05-05
  • Resolved Date: 2001-06-01
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availabitlity Release.

To download the current JDK release, click here.
1.4.0 beta2Fixed
Related Reports
Duplicate :  
Name: vi73552			Date: 03/04/99

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) 

CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: merlin-beta2 FIXED IN: merlin-beta2 INTEGRATED IN: merlin-beta2 VERIFIED IN: merlin-beta3

PUBLIC COMMENTS Added -quiet option to shut off non-error/warning noise. jamie.ho@Eng 2001-05-09

EVALUATION Added -quiet option to shut off non-error/warning noise. Location of fix: standard.properties ConfigurationStandard.java MessageRetriever.java jamie.ho@Eng 2001-05-09 We need to decide on this. atul.dambalkar@eng 1999-03-16 I believe this requires changes to both the javadoc tool and the standard doclet. doug.kramer@Eng 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. doug.kramer@Eng 2001-03-29