Bug 96270

Summary:	[javadoc] Missing Javadoc comment: 'check overriding..' should be 'off' by default
Product:	[Eclipse Project] JDT	Reporter:	Martin Aeschlimann <martinae>
Component:	Core	Assignee:	Frederic Fusier <frederic_fusier>
Status:	VERIFIED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	jeem
Version:	3.1
Target Milestone:	3.1 RC1
Hardware:	PC
OS:	Windows XP
Whiteboard:

Description Martin Aeschlimann

2005-05-23 03:58:18 EDT

20050522

The option 'check overriding..' in Missing Javadoc comment should disabled by
default.

The Javadoc tool always inherits Javadoc comments from a overriden method. In
fact you can't turn this off, the enforcement that also overriding method should
be commented is a question of style that should only be performed on users requests.

Important is taht the option should be in sync with the overridding comment
template which uses the (non-javadoc comment) style:
Currectly you get warnings on code generated by the new type wizard which is not
good.

When we decide to have 'check overriding..' off by default we will also change
the label on the preference page to something like 'Include overridding methods
to avoid inherited comments'.

Comment 1 Philipe Mulet

2005-05-23 04:22:34 EDT

+1

Comment 2 Frederic Fusier

2005-05-23 11:47:49 EDT

Fixed and released in HEAD.

Default for JavaCore constants #COMPILER_PB_MISSING_JAVADOC_TAGS_OVERRIDING and
#COMPILER_PB_MISSING_JAVADOC_COMMENTS_OVERRIDING is now "disabled" instead of
"enabled".

Javadoc comment of JavaCore#getDefaultOptions() method has been updated.

[jdt-core internal]
Changes done in CompilerOptions.

No test case added. To verify manually this fix, just open preference page at
Java>Compiler>Javadoc page and reset values to default. Then you should see that
"Check overriding and implementing methods" is no longer checked...

Comment 3 Frederic Fusier

2005-05-23 11:52:15 EDT

Jeem,
I put you CC of this bug (a little bit late perhaps...) as it is an API change
(change default values)...
Let me know if this is OK for you, thx

Comment 4 Jim des Rivieres

2005-05-23 12:51:37 EDT

API change approved

Comment 5 Olivier Thomann

2005-05-27 10:30:21 EDT

Verified in I20050526-2000