Bug 235272

Summary:

javadoc of JavaCore#COMPILER_PB_MISSING_JAVADOC_TAG_DESCRIPTION needs improvement

Product:

[Eclipse Project] JDT

Reporter:

Maxime Daniel <maxime_daniel>

Component:

Core

Assignee:

Jerome Lanneluc <jerome_lanneluc>

Status:

VERIFIED FIXED

QA Contact:

Severity:

minor

Priority:

CC:

Olivier_Thomann

Version:

3.4

Target Milestone:

3.5 M1

Hardware:

OS:

All

Whiteboard:

Attachments:

Description	Flags
Proposed change	none

Description Maxime Daniel

2008-06-03 02:14:47 EDT

v_871

While upgrading the ISV documentation, it occurred to me that the doc for COMPILER_PB_MISSING_JAVADOC_TAG_DESCRIPTION needed improvements. 
At the very least, the 'Report errors in tags option' proposition should be replaced by a link to the proper option (unambiguous, consistent with what we do in other constants documentation). 
I hooked up with Jérôme, Frédéric and Eric and we checked which option it was referring to. I also changed a couple more things in jdt_api_options.htm, and I believe that this could be the basis for similar changes in the javadoc.
In any case, this won't be a 3.4 change, but when fixing it in 3.5 pls sync up the javadoc and the doc.

Comment 1 Jerome Lanneluc

2008-06-05 11:21:21 EDT

Created attachment 103758 [details]
Proposed change

This change reconciles the doc (written by Maxime, thanks Maxime :-) ) with the Javadoc.

Comment 2 Jerome Lanneluc

2008-06-25 07:12:33 EDT

Change released for 3.5M1

Comment 3 Olivier Thomann

2008-08-06 13:59:52 EDT

Verified for 3.5M1 using I20080805-1307