United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4773013 Should be silent when -subpackages encounters directory with illegal Java name
JDK-4773013 : Should be silent when -subpackages encounters directory with illegal Java name

Details
Type:
Enhancement
Submit Date:
2002-11-02
Status:
Resolved
Updated Date:
2003-08-30
Project Name:
JDK
Resolved Date:
2003-08-30
Component:
tools
OS:
other
Sub-Component:
javadoc(tool)
CPU:
generic
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.4.0
Fixed Versions:
5.0 (tiger)

Related Reports

Sub Tasks

Description
A couple of developers in the past have indicated they want to 
store test files in the source tree near their corresponding source files.
That is, they would like to put them in the same directory, or 
a subdirectory, of those source files.

I'd like to recommend that they put test files in a directory whose name 
contains an illegal Java character, such as a hyphen in "test-files".
This works, but produces a warning, which seem unnecessary.

When using -subpackages, and when the source tree contains a directory
with an illegal subpackage name, such as "test-files" (contains a hyphen),
javadoc gives this warning:

  javadoc: warning - No source files for package com.package1.test-files

Javadoc does not warn if a source file in a valid directory contains a hyphen,
so it seems it should not warn when a subdirectory name contains a hyphen.
It should simply skip over that subdirectory, which would allow us to
keep test files (of the unnamed package, for instance) in that directory
with no side effects.

Here's how the warning is produced.  Given a package name com.package1
whose test directory is com/package1/test-files:

==> % ls -dF sample-src/com/package1/t*
sample-src/com/package1/test-files/

==> % more run-subpackages
/java/re/jdk/1.4.1/latest/binaries/solaris-sparc/bin/javadoc -d html-subpackages -sourcepath sample-src -subpackages com

==> % run-subpackages
Loading source files for package com.package1...
Loading source files for package com.package1.test-files...
Constructing Javadoc information...
javadoc: warning - No source files for package com.package1.test-files
Standard Doclet version 1.4.1
.
.
.

                                    

Comments
EVALUATION

reasonable.

###@###.### 2002-11-07
                                     
2002-11-07
PUBLIC COMMENTS

...
                                     
2004-06-10
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
tiger

FIXED IN:
tiger

INTEGRATED IN:
tiger
tiger-b18


                                     
2004-06-14



Hardware and Software, Engineered to Work Together