United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4506980 stddoclet: Should be no diff when passing in package names or .java file names
JDK-4506980 : stddoclet: Should be no diff when passing in package names or .java file names

Details
Type:
Bug
Submit Date:
2001-09-25
Status:
Resolved
Updated Date:
2004-04-01
Project Name:
JDK
Resolved Date:
2002-09-02
Component:
docs
OS:
solaris_2.6,windows_98
Sub-Component:
doclet
CPU:
x86,sparc
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.3.0,1.4.2
Fixed Versions:
1.4.2 (mantis)

Related Reports
Duplicate:
Duplicate:

Sub Tasks

Description
 When I run javadoc passing in package names or .java files, I expect
 to get the same results.  I tried doing this and diffing the results,
 but get different results.  
 
 Here I pass in .java files:
 
 /java/re/jdk/1.4.0/archive/beta2/binaries/solsparc/bin/javadoc  -J-Xbootclasspath/p:/home/jamieh/bin/standarddoclet.jar: /java/re/jdk/1.4.0/promoted/latest/binaries/solsparc/lib/tools.jar  -J-Xmx20M  -d html-javafiles  -quiet  -overview sample-src/overview.html  sample-src/com/package1/*.java sample-src/com/package2/*.java  sample-src/com/package1/subpackage/*.java
 
 Then I pass in package names, replacing the last line with:
 
 com.package1 com.package2 com.package1.subpackage
 
 One difference is that in the first case, the first sentence of packages
 does not appear on the overview page.
 
 Some diffs are in whether a link exists or not:
 
 238c238
 < <CODE>&nbsp;com.package1.Interface1</CODE></FONT></TD>
 ---
 > <CODE>&nbsp;<A HREF="../../com/package1/Interface1.html">Interface1</A></CODE></FONT></TD>
 
 Also, when .java files are passed in, the package tree is not
 generated.  Only the overview tree is generated in this case.


                                    

Comments
PUBLIC COMMENTS

This bug has been fixed.  The output should now be the same when you specify classes or packages on the command line.
###@###.### 2002-07-18
                                     
2002-07-18
EVALUATION

Important
###@###.### 2002-01-03

To eliminate differences in the output when classes or packages are specified on the command line, I had to make 3 changes:

1.  When classes are specified on the command line, group them in packages so that the next and prev links in the class documentation on link to other classes in the same package.

2.  Sort the members in the index builder so that they are always listed in the same order.  Specifying classes or packages on the command line used to make a difference in the ordering.  Now, they don't.

3.  Added -notimestamp to remove the time stamps from the output.  This allows us to diff the output and verify that the output is the same when you specify classes or packages in the command line.

This bug fix is pending review.

###@###.### 2002-07-18

This bug fix has been reviewed and approved.

###@###.### 2002-07-26

FYI, -noTimeStamp was implemented in some 1.4.x releases.
It was also implemented as -xnodate in even earlier releases (1.3).

###@###.### 2004-04-01
                                     
2002-07-26
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
mantis
mantis-b02

FIXED IN:
mantis
mantis-b02

INTEGRATED IN:
mantis
mantis-b02
mantis-b08


                                     
2004-06-14



Hardware and Software, Engineered to Work Together