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: 4507380
Votes 3
Synopsis Merlin javadoc cannot handle packages named *.java (regression)
Category java:javadoctool
Reported Against 1.4 , 1.4.1 , merlin-rc1 , merlin-beta , merlin-beta2
Release Fixed 1.4.1(hopper)
State 10-Fix Delivered, Verified, bug
Priority: 4-Low
Related Bugs 4482379 , 4507743 , 4701470 , 4821648
Submit Date 26-SEP-2001
Description
..




java version "1.4.0-beta2"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.0-beta2-b77)
Java HotSpot(TM) Client VM (build 1.4.0-beta2-b77, mixed mode)


If you have a package named "java" (obviously not a top-level package), then
javadoc reports an error when constructing the javadocs.

e.g:

package a.java;
public class A {
}


Using the 1.4 javadoc command gives:

[ xxxxx@xxxxx  java_test]$ javadoc -d doc a.java
Loading source file a.java...
error: cannot read: a.java
1 error

Using the 1.3 javadoc command gives:
[ xxxxx@xxxxx  java_test]$ javadoc -d doc a.java
Loading source files for package a.java...
Constructing Javadoc information...
Building tree for all the packages and classes...
Building index for all the packages and classes...
Generating doc/overview-tree.html...
Generating doc/index-all.html...
Generating doc/deprecated-list.html...
Building index for all classes...
Generating doc/allclasses-frame.html...
Generating doc/index.html...
Generating doc/packages.html...
Generating doc/a/java/package-summary.html...
Generating doc/a/java/package-tree.html...
Generating doc/a/java/package-frame.html...
Generating doc/a/java/A.html...
Generating doc/serialized-form.html...
Generating doc/package-list...
Generating doc/help-doc.html...
Generating doc/stylesheet.css...
and generates the expected documentation.
(We have a package named java to implement a custom url protocol named java:,
and having a package named after the protocol is one method for registering such
protocols)
(Review ID: 132606) 
======================================================================
Work Around




Omit that package from javadoc generation.

-or-

List the source files individually on the command line.

 xxxxx@xxxxx  2001-09-26
Evaluation
This is a dup of 4482379, which was closed as will not fix.  However, as this
bug reports the problem as a regression, I am keeping it open.

 xxxxx@xxxxx  2001-09-26
Comments
  
  Include a link with my name & email   

Submitted On 06-JAN-2002
jch5689
Note that its not always easy to omit the package or list
the source files. For example, when building javadoc with
ant's javadoc build task, the javadoc command is formed
automatically, and uses package names. Additionally, on some
operating systems (Solaris) there is a real possibility of
generating a command that fails because its too long if you
list the files in the *.java way (I've had this happen before).

Please fix this


Submitted On 30-JAN-2002
m9407780
There is another workaround: use the -subpackages option of 
the javadoc command. See: 
http://java.sun.com/j2se/1.4/docs/tooldocs/win32/javadoc.htm
l#subpackages

I also had the same problem with a packagename ending 
with "java": "com.somepackage.java", but this command did 
generate the javadocs:

javadoc -d docs -sourcepath src\java -subpackages com

or, if you are using ant:

<javadoc ... additionalparam="-subpackages com" />

Maarten


Submitted On 23-APR-2002
linxu01
This bug still in the jdk 1.4.0. Please fix this!



PLEASE NOTE: JDK6 is formerly known as Project Mustang