Bug 134775 - [misc] javadoc extraction: member comments should look like javadoc extracted from source
Summary: [misc] javadoc extraction: member comments should look like javadoc extracted...
Status: ASSIGNED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Text (show other bugs)
Version: 3.2   Edit
Hardware: PC All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: JDT-Text-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-04-04 11:21 EDT by Tom Hofmann CLA
Modified: 2007-09-28 08:57 EDT (History)
1 user (show)

See Also:


Attachments
javadoc.png (17.56 KB, image/png)
2006-04-04 11:24 EDT, Tom Hofmann CLA
no flags Details
source.png (14.01 KB, image/png)
2006-04-04 11:24 EDT, Tom Hofmann CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Tom Hofmann CLA 2006-04-04 11:21:34 EDT
3.2 M6

Similar to bug 119844: When member javadoc is extracted from attached javadoc (as opposed to from attached source), there is some additional information included that is generated by the javadoc tool:

- a title consisting of the member name (e.g. "currentThread")
- the repetition of the entire member declaration including modifiers and (for methods) the return type and arguments (e.g. "public static Thread currentThread()")
- the actual javadoc body is indented
- a horizontal ruler (<hr> tag) after the javadoc

While this additional HTML is not as bad as the hierarchy for type javadocs (see bug 119844), I still think it would be cool to get as close to what we get when extracting javadoc from source.

Not sure if this is doable with all the different doclets out there...

I will add screenshots that show the difference.
Comment 1 Tom Hofmann CLA 2006-04-04 11:24:09 EDT
Created attachment 37635 [details]
javadoc.png

Javadoc View for Thread.currentThread when extracted from javadoc.
Comment 2 Tom Hofmann CLA 2006-04-04 11:24:35 EDT
Created attachment 37636 [details]
source.png

Javadoc View when information is extracted from source.
Comment 3 Olivier Thomann CLA 2006-04-04 17:09:52 EDT
Unfortunately I cannot change it for method javadoc since the first part that you want to get rid of is used to retrieve the parameter names.
However this could be done on the UI side.
You can extract what is defined between the first <DL> and the last <HR>. This is the part that you want.
Moving to JDT/Text for further investigation.