Bug 75701 - [Javadoc] References in Javadoc to deprecated members
Summary: [Javadoc] References in Javadoc to deprecated members
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.0   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: 3.1 M3   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 71797 (view as bug list)
Depends on:
Blocks:
 
Reported: 2004-10-06 07:06 EDT by Dirk Baeumer CLA
Modified: 2013-07-29 08:25 EDT (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Dirk Baeumer CLA 2004-10-06 07:06:36 EDT 
If I reference a deprecared member inside a Javadoc the reference is flaged 
with a deprecated warning. I would like to disable this.
Comment 1 Frederic Fusier CLA 2004-10-06 07:51:25 EDT 
See also bug 53977.
Comment 2 Frederic Fusier CLA 2004-10-18 14:42:27 EDT 
Fixed.

New compiler option has been added to address this issue:
 * COMPILER / Reporting Invalid Javadoc Tags with Deprecated References
 *    Specify whether the compiler will report deprecated references used in
Javadoc tags.
 *    <br>Note that this diagnosis can be enabled based on the visibility of the
construct associated with the Javadoc;
 *    also see the setting
"org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility".
 *     - option id:        
"org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef"
 *     - possible values:   { "enabled", "disabled" }
 *     - default:           "enabled"
 * 

See also bug 53977.

[jdt-core-internal]
Test cases added in JavadocTestOptions.
Comment 3 Frederic Fusier CLA 2004-10-28 12:58:50 EDT 
*** Bug 71797 has been marked as a duplicate of this bug. ***
Comment 4 Randy Hudson CLA 2004-10-28 15:22:39 EDT 
Maybe there should be a 3rd option (or enabled should work differently).  If 
the method/class containing the JavaDoc is also @deprecated, then it should be 
able to refer to other @deprecated API without any warnings. And this should be 
the default setting, as it is with method calls.  "Signal the use of deprecated 
API within deprecated code" is disabled by default.
Comment 5 David Audel CLA 2004-11-04 04:20:13 EST 
Verified for 3.1M3 with build I20041102