Bug 50683 - Improve DOM/AST support for doc comments
Summary: Improve DOM/AST support for doc comments
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 2.1   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 3.0 M7   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 25316 46126 (view as bug list)
Depends on:
Blocks: 46126
  Show dependency tree
 
Reported: 2004-01-27 10:16 EST by Jim des Rivieres CLA
Modified: 2004-06-21 10:36 EDT (History)
2 users (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 Jim des Rivieres CLA 2004-01-27 10:16:48 EST 
The current API for doc comments has a flat text string.
This is not helpful for clients that want to analyze or change the structure 
of doc comments.
Comment 1 Jim des Rivieres CLA 2004-01-27 13:19:10 EST 
For M7, we have made the following changes to the DOM/AST API:

- added Javadoc.tags() to represent structure of the doc comments
- deprecated Javadoc.get/setComment
- added 5 new node types that occur only within doc comments:
    TagElement, TextElement, MemberRef, MethodRef, MethodRefParameter
- tag elements like MemberRef, MethodRef, and Name can carry binding 
information (must be requested like elsewhere)
- added ASTVisitor(boolean) for controlling whether Javadoc.tags() are visited 
by default
- added ASTMatcher(boolean) for controlling whether Javadoc.tags() are 
compared vs. only Javadoc.getComment()
- AST.parse*(...) now returns structured doc comments (for compatibility, 
Javadoc.getComment() is also set as before)
Comment 2 Frederic Fusier CLA 2004-01-28 04:51:41 EST 
Reopen to assign it to me
Comment 3 Frederic Fusier CLA 2004-01-28 04:53:01 EST 
Test cases need to be completed...
Comment 4 Philipe Mulet CLA 2004-01-29 08:02:17 EST 
*** Bug 46126 has been marked as a duplicate of this bug. ***
Comment 5 David Audel CLA 2004-02-11 10:48:03 EST 
Verified for 3.0M7
Comment 6 Frederic Fusier CLA 2004-06-21 10:36:55 EDT 
*** Bug 25316 has been marked as a duplicate of this bug. ***