|
Quick Lists
|
|
Bug ID:
|
4506980
|
|
Votes
|
0
|
|
Synopsis
|
stddoclet: Should be no diff when passing in package names or .java file names
|
|
Category
|
doclet:tbd
|
|
Reported Against
|
1.3
, 1.4.2
|
|
Release Fixed
|
1.4.2(mantis)
|
|
State
|
10-Fix Delivered,
bug
|
|
Priority:
|
4-Low
|
|
Related Bugs
|
4470135
,
5025224
|
|
Submit Date
|
25-SEP-2001
|
|
Description
|
This bug has been fixed. The output should now be the same when you specify classes or packages on the command line.
xxxxx@xxxxx 2002-07-18 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> com.package1.Interface1</CODE></FONT></TD>
---
> <CODE> <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.
|
|
Work Around
|
N/A
|
|
Evaluation
|
Important
xxxxx@xxxxx 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.
xxxxx@xxxxx 2002-07-18
This bug fix has been reviewed and approved.
xxxxx@xxxxx 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).
xxxxx@xxxxx 2004-04-01
|
|
Comments
|
Submitted On 15-NOV-2001
aaron_h
The most annoying part of this bug is that JavaDoc refuses
to generate a package listing for any files or classes
specified directly on the command line (as opposed to
packages).
E.g. javadoc a.b.c1 a.b.c2 a/b/MyClass1.java
a/b/MyClass2.java
Will generate a package overview for package a.b.c1, and
a.b.c2, but NO package overview for a.b, containing classes
MyClass1 and MyClass2. There will be no link in the top,
left frame, and the only way to access the javadoc is to
click "All Classes" and select the class from there. I'd
presume JavaDoc could derive the packages that a set of
source files belong to, and then generate package overview
files for them.
PLEASE NOTE: JDK6 is formerly known as Project Mustang
|
|
|
 |