Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 342695

Summary:	@since tag error removed on class method after touching the interface
Product:	[Eclipse Project] PDE	Reporter:	Dani Megert <daniel_megert>
Component:	API Tools	Assignee:	PDE API Tools Inbox <pde-apitools-inbox>
Status:	CLOSED WONTFIX	QA Contact:
Severity:	normal
Priority:	P3	CC:	Olivier_Thomann, remy.suen, tomasz.zarna
Version:	3.7
Target Milestone:	---
Hardware:	All
OS:	All
Whiteboard:	stalebug

Description Dani Megert

2011-04-13 06:35:36 EDT

I20110412-1532.

API Tools reports a unexpected missing @since tag error which I can't get rid of (reappears after a full build).

Test Case:
1. check out 'org.eclipse.team.core' from CVS
2. set API baseline to 3.6
3. full build
==> Missing @since tag on getBranches()	FileRevision.java	

NOTE: Touching IFileRevision.java makes the error go away but another full build brings it back.

Comment 1 Olivier Thomann

2011-04-13 12:16:35 EDT

The corresponding method has no javadoc comment. So API tools reports a missing @since tag. Block comments are not "parsed" to check @since tags.
To get rid of the problem, the comment of this method should be converted to a javadoc comment.
Now I am investigating why the problem goes away when the interface is modified. This is the bug, not the fact that the missing @since tags is reported.

Comment 2 Olivier Thomann

2011-04-13 12:18:55 EDT

To make it short, the problem is reported because:
1) This is an API method
2) It has no javadoc
3) It was added since previous version (from the baseline 3.6.x).

Did I miss something ?

Comment 3 Olivier Thomann

2011-04-13 12:38:20 EDT

Reducing severity as I don't see why this error should not be reported.

When IFileRevision is touched, the markers on dependents are removed, but in this case FileRevision is not processed by the api tools builder so the marker is not created again.

Comment 4 Michael Rennie

2011-04-13 12:39:26 EDT

I'll look into this one

Comment 5 Dani Megert

2011-04-14 02:19:59 EDT

(In reply to comment #2)
> To make it short, the problem is reported because:
> 1) This is an API method
> 2) It has no javadoc
> 3) It was added since previous version (from the baseline 3.6.x).
> 
> Did I miss something ?

No, nothing - my bad. I wrongly thought that the @since tag is inherited but it is not: http://download.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#inheritingcomments. Sorry about that.


Regarding the problem that it disappears: this might be related to bug 321302.

Comment 6 Eclipse Genie

2019-09-17 00:25:58 EDT

This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.

--
The automated Eclipse Genie.