Bug 273590 - [javadoc] Compiler may have a preference to warn on custom javadoc tags
Summary: [javadoc] Compiler may have a preference to warn on custom javadoc tags
Status: NEW
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.5   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: JDT-Core-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 39699
Blocks:
  Show dependency tree
 
Reported: 2009-04-24 09:28 EDT by Frederic Fusier CLA
Modified: 2010-05-05 08:38 EDT (History)
1 user (show)

See Also:


Attachments
Patch fixing warnings in HEAD (4.94 KB, patch)
2009-04-24 09:31 EDT, Frederic Fusier CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Frederic Fusier CLA 2009-04-24 09:28:03 EDT
Follow-up of bug 267833.

It may be useful that the compiler report warnings on custom tags when I do not expect to use any in my javadoc comments.

After having installed build I20090421-0930 which includes bug 267833 first patch (https://bugs.eclipse.org/bugs/attachment.cgi?id=132079), I saw that there are several additional warnings in JDT/Core projects.

Typically, in CompilerOptions, the following code was written:
	/** 
	 * Defaults defined at {@lnk IrritantSet#COMPILER_DEFAULT_ERRORS} 
	 * @see #resetDefaults()
	 */
	protected IrritantSet errorThreshold;
	/** 
	 * Defaults defined at {@lnk IrritantSet#COMPILER_DEFAULT_WARNINGS}
	 * @see #resetDefaults()
	 */
	protected IrritantSet warningThreshold;

As it was obviously the @link tag which was intented to be written there, I think the compiler warnings were not so stupid here...

Of course, this must be controlled by a preference which could be:
1. a simple boolean to report warnings/errors on custom tags or not,
2. additional preferences to distinguish inline and block custom tags
3. or more elaborate preferences allowing to specify the list of expected custom tags (see also bug 39699)
Comment 1 Frederic Fusier CLA 2009-04-24 09:31:15 EDT
Created attachment 133118 [details]
Patch fixing warnings in HEAD

Released in HEAD