Bug 36887

Summary: Extend Java Model to know about content of Javadoc
Product: [Eclipse Project] JDT Reporter: Jerome Lanneluc <jerome_lanneluc>
Component: CoreAssignee: Frederic Fusier <frederic_fusier>
Status: RESOLVED DUPLICATE QA Contact:
Severity: normal    
Priority: P3 CC: csmclaren, nikolaymetchev
Version: 2.1   
Target Milestone: 3.0 M8   
Hardware: PC   
OS: Windows 2000   
Whiteboard:
Bug Depends on:    
Bug Blocks: 23530, 25309    

Description Jerome Lanneluc CLA 2003-04-25 07:26:37 EDT 
Build 2.1

Extend Java Model to know about content of Javadoc (@see @link @param, 
<code></code> <tt></tt>
   o referenced Java elements should be in index
   o Javadoc node in AST has information about the referenced Java elements.
Comment 1 Adam Kiezun CLA 2003-04-25 11:01:49 EDT 
*** Bug 22110 has been marked as a duplicate of this bug. ***
Comment 2 Martin Aeschlimann CLA 2003-04-25 12:59:57 EDT 
Suggestion is to do it similar to the Doclet API
'grammar' of a Javadoc comment is:

[top-tag-text]
{@tag tag-text}

A tag starts with a @-character. It has a name (@tag) and a text. The comment
contains all characters until the next tag.
The top-tag is a nameless tag. It contains all characters from the start of the
comment until the first tag (@xx) .
The format of the tag comment is specific to the tag. There are some defined
tags (@param, @see, ect), but users can define their own tags.

There are special constructs (tags in curly backets) which are belonging to the
tag-texts (inline tags)


This means there is no structure needed for things like <code></code> or <tt></tt>.
Comment 3 Stephen Colebourne CLA 2003-06-26 19:11:39 EDT 
Assuming this is completed, the next natural addition is to keep the javadoc 
tags up to date with the method params. For example renaming a method variable 
should rename the @param name, and adding/removing a parameter should 
add/remove an @param. Similarly with @return and @throws.
Comment 4 Philipe Mulet CLA 2004-03-25 06:24:24 EST 
Closing, support got added to DOM AST, search and compiler.

*** This bug has been marked as a duplicate of 38091 ***