Bug 80602 - Javadoc of ASTNode#getStartPosition() contains dangling reference to ASTParser
Summary: Javadoc of ASTNode#getStartPosition() contains dangling reference to ASTParser
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.1   Edit
Hardware: PC Windows XP
: P3 minor (vote)
Target Milestone: 3.1 M4   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-12-09 11:04 EST by Markus Keller CLA
Modified: 2004-12-14 12:00 EST (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Markus Keller CLA 2004-12-09 11:04:09 EST 
I20041208-1200

Javadocs of ASTNode#getStartPosition() and #getLength() contain dangling
references to ASTParser:
	 * See {@link ASTParser} for details
	 * on precisely where source ranges begin and end.

I could not find any information in ASTParser that would describe the source
range more precisely. As I understand the API, the source range always stretches
over the whole range delineated by the grammar section in an ASTNode subclass'
javadoc.
Comment 1 Frederic Fusier CLA 2004-12-09 11:48:06 EST 
Jeem,
Perhaps may you provide help on this?
Thanks
Comment 2 Jim des Rivieres CLA 2004-12-09 12:24:36 EST 
Thanks for catching this. I've changed the specs to {@link ASTParser#setKind
(int)}, which is where the source range is explained. Yes, the source range 
always stretches over the whole range delineated by the grammar section in an 
ASTNode subclass' javadoc. Leading and training whitespace and comments are 
not included (but BodyDeclarations have optional Javadoc child node and do 
include preceding doc comment).

Updated build notes. Closing.
Comment 3 Olivier Thomann CLA 2004-12-14 12:00:23 EST 
Verified in 200412140800