-
Bug
-
Resolution: Fixed
-
P3
-
5.0
-
b32
-
x86
-
windows_2000
FULL PRODUCT VERSION :
java version "1.4.2_03"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_03-b02)
OJVM Client VM (build 9.0.4.889 cdov, Copyright (c) 1998-2003 Oracle Corp., noj
it)
ADDITIONAL OS VERSION INFORMATION :
Windows 2000 (but problem is independent of platform)
A DESCRIPTION OF THE PROBLEM :
JavaDoc-Strings in the ExampleFileFilter (in demo/jfc directory in the Java 2 SDK, Standard Edition) are incorrect
(@see tags are in incorrect format or the method-name is misspelled.)
STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
Try to generate the documentation for the file using javadoc
EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
Correct documentation and no errors or warnings
ACTUAL -
No correct documentation: Instead of @see-Links partly plain text is generated.
ERROR MESSAGES/STACK TRACES THAT OCCUR :
A bunch of warnings:
Generating Z:\java\jcolibrimatch\jcolibrimatch\javadoc\colibri\ExampleFileFilter.html...
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:211: warning - Tag @see: reference not found: setDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:211: warning - Tag @see: reference not found: setExtensionListInDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:211: warning - Tag @see: reference not found: isExtensionListInDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:239: warning - Tag @see: reference not found: setDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:239: warning - Tag @see: reference not found: setExtensionListInDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:239: warning - Tag @see: reference not found: isExtensionListInDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:255: warning - Tag @see: reference not found: getDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:255: warning - Tag @see: reference not found: setDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:255: warning - Tag @see: reference not found: isExtensionListInDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:271: warning - Tag @see: reference not found: getDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:271: warning - Tag @see: reference not found: setDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:271: warning - Tag @see: reference not found: setExtensionListInDescription
REPRODUCIBILITY :
This bug can be reproduced always.
CUSTOMER SUBMITTED WORKAROUND :
Here are the changes I made as context-diff:
===================================================================
RCS file: /home/jost/cvs/jcolibrimatch/jcolibrimatch/src/colibri/ExtensionFileFi
lter.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -c -r1.1 -r1.2
*** ExtensionFileFilter.java 27 Jan 2005 11:49:50 -0000 1.1
--- ExtensionFileFilter.java 27 Jan 2005 16:16:51 -0000 1.2
***************
*** 150,156 ****
* Files that begin with "." are ignored.
*
* @see #getExtension
! * @see FileFilter#accepts
*/
public boolean accept(File f)
{
--- 150,156 ----
* Files that begin with "." are ignored.
*
* @see #getExtension
! * @see FileFilter#accept(File)
*/
public boolean accept(File f)
{
***************
*** 174,180 ****
* Return the extension portion of the file's name .
*
* @see #getExtension
! * @see FileFilter#accept
*/
public String getExtension(File f)
{
--- 174,180 ----
* Return the extension portion of the file's name .
*
* @see #getExtension
! * @see FileFilter#accept(File)
*/
public String getExtension(File f)
{
***************
*** 217,226 ****
* Returns the human readable description of this filter. For
* example: "JPEG and GIF Image Files (*.jpg, *.gif)"
*
! * @see setDescription
! * @see setExtensionListInDescription
! * @see isExtensionListInDescription
! * @see FileFilter#getDescription
*/
public String getDescription()
{
--- 217,226 ----
* Returns the human readable description of this filter. For
* example: "JPEG and GIF Image Files (*.jpg, *.gif)"
*
! * @see #setDescription(String)
! * @see #setExtensionListInDescription(boolean)
! * @see #isExtensionListInDescription()
! * @see FileFilter#getDescription()
*/
public String getDescription()
{
***************
*** 253,261 ****
* Sets the human readable description of this filter. For
* example: filter.setDescription("Gif and JPG Images");
*
! * @see setDescription
! * @see setExtensionListInDescription
! * @see isExtensionListInDescription
*/
public void setDescription(String description)
{
--- 253,261 ----
* Sets the human readable description of this filter. For
* example: filter.setDescription("Gif and JPG Images");
*
! * @see #setDescription(String)
! * @see #setExtensionListInDescription(boolean)
! * @see #isExtensionListInDescription()
*/
public void setDescription(String description)
{
***************
*** 270,278 ****
* Only relevent if a description was provided in the constructor
* or using setDescription();
*
! * @see getDescription
! * @see setDescription
! * @see isExtensionListInDescription
*/
public void setExtensionListInDescription(boolean b)
{
--- 270,278 ----
* Only relevent if a description was provided in the constructor
* or using setDescription();
*
! * @see #getDescription()
! * @see #setDescription(String)
! * @see #isExtensionListInDescription()
*/
public void setExtensionListInDescription(boolean b)
{
***************
*** 287,295 ****
* Only relevent if a description was provided in the constructor
* or using setDescription();
*
! * @see getDescription
! * @see setDescription
! * @see setExtensionListInDescription
*/
public boolean isExtensionListInDescription()
{
--- 287,295 ----
* Only relevent if a description was provided in the constructor
* or using setDescription();
*
! * @see #getDescription
! * @see #setDescription(String)
! * @see #setExtensionListInDescription(boolean)
*/
public boolean isExtensionListInDescription()
{
###@###.### 2005-03-11 17:44:12 GMT
java version "1.4.2_03"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_03-b02)
OJVM Client VM (build 9.0.4.889 cdov, Copyright (c) 1998-2003 Oracle Corp., noj
it)
ADDITIONAL OS VERSION INFORMATION :
Windows 2000 (but problem is independent of platform)
A DESCRIPTION OF THE PROBLEM :
JavaDoc-Strings in the ExampleFileFilter (in demo/jfc directory in the Java 2 SDK, Standard Edition) are incorrect
(@see tags are in incorrect format or the method-name is misspelled.)
STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
Try to generate the documentation for the file using javadoc
EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
Correct documentation and no errors or warnings
ACTUAL -
No correct documentation: Instead of @see-Links partly plain text is generated.
ERROR MESSAGES/STACK TRACES THAT OCCUR :
A bunch of warnings:
Generating Z:\java\jcolibrimatch\jcolibrimatch\javadoc\colibri\ExampleFileFilter.html...
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:211: warning - Tag @see: reference not found: setDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:211: warning - Tag @see: reference not found: setExtensionListInDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:211: warning - Tag @see: reference not found: isExtensionListInDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:239: warning - Tag @see: reference not found: setDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:239: warning - Tag @see: reference not found: setExtensionListInDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:239: warning - Tag @see: reference not found: isExtensionListInDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:255: warning - Tag @see: reference not found: getDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:255: warning - Tag @see: reference not found: setDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:255: warning - Tag @see: reference not found: isExtensionListInDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:271: warning - Tag @see: reference not found: getDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:271: warning - Tag @see: reference not found: setDescription
Z:\java\jcolibrimatch\jcolibrimatch\src\colibri\ExampleFileFilter.java:271: warning - Tag @see: reference not found: setExtensionListInDescription
REPRODUCIBILITY :
This bug can be reproduced always.
CUSTOMER SUBMITTED WORKAROUND :
Here are the changes I made as context-diff:
===================================================================
RCS file: /home/jost/cvs/jcolibrimatch/jcolibrimatch/src/colibri/ExtensionFileFi
lter.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -c -r1.1 -r1.2
*** ExtensionFileFilter.java 27 Jan 2005 11:49:50 -0000 1.1
--- ExtensionFileFilter.java 27 Jan 2005 16:16:51 -0000 1.2
***************
*** 150,156 ****
* Files that begin with "." are ignored.
*
* @see #getExtension
! * @see FileFilter#accepts
*/
public boolean accept(File f)
{
--- 150,156 ----
* Files that begin with "." are ignored.
*
* @see #getExtension
! * @see FileFilter#accept(File)
*/
public boolean accept(File f)
{
***************
*** 174,180 ****
* Return the extension portion of the file's name .
*
* @see #getExtension
! * @see FileFilter#accept
*/
public String getExtension(File f)
{
--- 174,180 ----
* Return the extension portion of the file's name .
*
* @see #getExtension
! * @see FileFilter#accept(File)
*/
public String getExtension(File f)
{
***************
*** 217,226 ****
* Returns the human readable description of this filter. For
* example: "JPEG and GIF Image Files (*.jpg, *.gif)"
*
! * @see setDescription
! * @see setExtensionListInDescription
! * @see isExtensionListInDescription
! * @see FileFilter#getDescription
*/
public String getDescription()
{
--- 217,226 ----
* Returns the human readable description of this filter. For
* example: "JPEG and GIF Image Files (*.jpg, *.gif)"
*
! * @see #setDescription(String)
! * @see #setExtensionListInDescription(boolean)
! * @see #isExtensionListInDescription()
! * @see FileFilter#getDescription()
*/
public String getDescription()
{
***************
*** 253,261 ****
* Sets the human readable description of this filter. For
* example: filter.setDescription("Gif and JPG Images");
*
! * @see setDescription
! * @see setExtensionListInDescription
! * @see isExtensionListInDescription
*/
public void setDescription(String description)
{
--- 253,261 ----
* Sets the human readable description of this filter. For
* example: filter.setDescription("Gif and JPG Images");
*
! * @see #setDescription(String)
! * @see #setExtensionListInDescription(boolean)
! * @see #isExtensionListInDescription()
*/
public void setDescription(String description)
{
***************
*** 270,278 ****
* Only relevent if a description was provided in the constructor
* or using setDescription();
*
! * @see getDescription
! * @see setDescription
! * @see isExtensionListInDescription
*/
public void setExtensionListInDescription(boolean b)
{
--- 270,278 ----
* Only relevent if a description was provided in the constructor
* or using setDescription();
*
! * @see #getDescription()
! * @see #setDescription(String)
! * @see #isExtensionListInDescription()
*/
public void setExtensionListInDescription(boolean b)
{
***************
*** 287,295 ****
* Only relevent if a description was provided in the constructor
* or using setDescription();
*
! * @see getDescription
! * @see setDescription
! * @see setExtensionListInDescription
*/
public boolean isExtensionListInDescription()
{
--- 287,295 ----
* Only relevent if a description was provided in the constructor
* or using setDescription();
*
! * @see #getDescription
! * @see #setDescription(String)
! * @see #setExtensionListInDescription(boolean)
*/
public boolean isExtensionListInDescription()
{
###@###.### 2005-03-11 17:44:12 GMT