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

Bug 217837

Summary:	[spec] Improve documentation for IMember#getJavadocRange
Product:	[Eclipse Project] JDT	Reporter:	Maxime Daniel <maxime_daniel>
Component:	Core	Assignee:	JDT-Core-Inbox <jdt-core-inbox>
Status:	CLOSED WONTFIX	QA Contact:
Severity:	normal
Priority:	P3
Version:	3.4
Target Milestone:	---
Hardware:	PC
OS:	All
Whiteboard:	stalebug

Description Maxime Daniel

2008-02-05 09:30:39 EST

(And maybe ISourceReference#getSourceRange.)

Source based, v_835

Verifying bug 214284, it occurred to me thatIMember#getJavadocRange needed to get improved in at least two respects:
- internal consistency; it returns a range (properly documented for source files), not a javadoc content (as wrongly documented for attached files);
- the relationship between an element's range and it's javadoc range; bug 214284 makes clear that the latter defines an interval that is included into the one defined by the former, and this constitutes the core argument for closing the said bug; yet the documentation of the relevant interfaces is mute about this, and while the behavior we have chosen is perfectly fine, alternatives exist that would have their own merits - including ones that would be just as intuitive as the current behavior, that would still be compatible with the documentation, but would be quite different in their effects; I would hence suggest that the documentation be tightened in that area.

Comment 1 Eclipse Genie

2018-11-04 15:03:54 EST

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.