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: 4256505
Votes 0
Synopsis stddoclet: doc-files directory at doc root should be copied to destination
Category doclet:tbd
Reported Against 1.2
Release Fixed 1.4(merlin-beta2)
State 10-Fix Delivered, Verified, bug
Priority: 4-Low
Related Bugs
Submit Date 22-JUL-1999
Description
This bug has been fixed.  The standard doclet now copies doc-files at the root-level to the destination directory.  If there are two files with the same name, but in different root-level doc-file directories, a warning message is printed and the first file is not overwritten by the second one (as described in the suggested fix).

 xxxxx@xxxxx  2001-05-11It is important that the user be able to place a top-level doc-files directory
in the source tree, for putting the copyright.html, logos and other files that 
are not specific to any one package.   Javadoc does not currently copy this
directory to the destination, but should.

One developer has asked for a generalization of this feature, where
a doc-files directory can be placed in *any* source subdirectory
below the root in the package path and javadoc will copy it.
For example, com.mycompany.mypackage could have a doc-files
directory at com/doc-files, even though com is not technically
a package (because it contains no source files).

Note:  Files in doc-files are not processed, and so the copyright page will
not have the navigation bars at the top and bottom.
Work Around
N/A
Evaluation
This bug has been fixed.  The standard doclet now copies doc-files at the root-level to the destination directory.  If there are two files with the same name, but in different root-level doc-file directories, a warning message is printed and the first file is not overwritten by the second one (as described in the suggested fix).

Location of fix:

ClassWriter.java
PackageWriter.java
Standard.java
standard.properties

 xxxxx@xxxxx  2001-05-11

Need to fix for Kestrel, in order to make @docRoot useful.
 xxxxx@xxxxx  1999-07-22
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang