United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4256505 : stddoclet: doc-files directory at doc root should be copied to destination

Details
Type:
Bug
Submit Date:
1999-07-22
Status:
Closed
Updated Date:
2014-05-05
Project Name:
JDK
Resolved Date:
2001-06-01
Component:
tools
OS:
solaris_2.5
Sub-Component:
javadoc(tool)
CPU:
sparc
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.2.0
Fixed Versions:
1.4.0 (beta2)

Related Reports

Sub Tasks

Description
It 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.

                                    

Comments
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
merlin-beta2

FIXED IN:
merlin-beta2

INTEGRATED IN:
merlin-beta2

VERIFIED IN:
merlin-rc1


                                     
2004-06-14
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

jamie.ho@Eng 2001-05-11

Need to fix for Kestrel, in order to make @docRoot useful.
doug.kramer@Eng 1999-07-22
                                     
2001-05-11
PUBLIC COMMENTS

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

jamie.ho@Eng 2001-05-11
                                     
2001-05-11
SUGGESTED FIX

Jamie and I have talked and decided the best solution is to keep it simple and limit it to one doc-files directory at the root level.  If there are name clashes, the doclet should print out a warning message stating the name and destination path of the file.  It probably makes sense not to overwrite any files, and let the first file copied there take precedence.  The warning message might say something like this:

   File "myimage.gif" not copied to /usr/local/api/doc-files due to existing file with same name

doug.kramer@Eng 2000-08-31
                                     
2000-08-31



Hardware and Software, Engineered to Work Together