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: 4114089
Votes 1
Synopsis stddoclet: javadoc needs a -v switch to report its version
Category doclet:tbd
Reported Against 1.2beta3 , merlin-beta2
Release Fixed 1.4(merlin-beta2)
State 10-Fix Delivered, Verified, request for enhancement
Priority: 5-Very Low
Related Bugs 4494076
Submit Date 21-FEB-1998
Description
This has been implemented not by adding -v switch, but by printing the version number during each run of the standard doclet.  If -quiet is used, the version is only printed when an error or warning message is printed.

 xxxxx@xxxxx  2001-06-14When our build process runs, I don't know what version of javadoc
it used. If a -v switch reported its version, we could add that
information to the output listing. (Helpful when determining whether
or not bugs in the generated docs will be eliminated during the next
build.) 
Work Around
N/A
Evaluation
Not sure "-v" is the correct switch name, but this switch is needed.
 xxxxx@xxxxx  1998-02-20

The "javadoc -J-version" reaches through and prints the "java" version:

  % java version "1.2"
  Classic VM (build JDK-1.2-V, green threads, sunwjit)

which is interesting but not the same.  Is it enough of a difference to matter?

I suggest we do what the MIF doclet does, and always print the version
to the output stream.  Then no switch is needed (which would be confused
with the -version switch that javadoc already has).  I suggest the javadoc
tool print its version and the standard doclet print its version.
There will be people modifying the standard doclet, wanting to know its
version separate from the javadoc or java version.
 xxxxx@xxxxx  2001-03-01

I also suggest that the version not be printed when -quiet is used
if there are no warnings or errors.  However, if there are any
printed warnings or errors, go ahead and display the version.
Users seeking help can then just paste the output in an email and
it will automatically include the version string.  Also, including
separate version numbers for both javadoc and the doclet will show which
errors are for which parts of the software.
 xxxxx@xxxxx  2001-06-12

This has been implemented.  The version is printed during each run of the standard doclet.  If -quiet is used, the version is only printed when an error or warning message is printed.

Location of fix:

HtmlStandardWriter.java
Standard.java
standard.properties

 xxxxx@xxxxx  2001-06-14
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang