United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4114089 : stddoclet: javadoc needs a -v switch to report its version

Details
Type:
Enhancement
Submit Date:
1998-02-21
Status:
Closed
Updated Date:
2014-05-05
Project Name:
JDK
Resolved Date:
2001-07-13
Component:
tools
OS:
solaris_2.6,generic
Sub-Component:
javadoc(tool)
CPU:
generic
Priority:
P5
Resolution:
Fixed
Affected Versions:
1.2.0,1.4.0
Fixed Versions:
1.4.0 (beta2)

Related Reports
Duplicate:

Sub Tasks

Description
When 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.) 

                                    

Comments
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
merlin-beta2

FIXED IN:
merlin-beta2

INTEGRATED IN:
merlin-beta2

VERIFIED IN:
merlin-beta3


                                     
2004-06-14
EVALUATION

Not sure "-v" is the correct switch name, but this switch is needed.
robert.field@Eng 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.
doug.kramer@Eng 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.
doug.kramer@Eng 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

jamie.ho@Eng 2001-06-14
                                     
2001-06-14
PUBLIC COMMENTS

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.

jamie.ho@Eng 2001-06-14
                                     
2001-06-14



Hardware and Software, Engineered to Work Together