Bug 235295 - [formatter] javadoc of CodeFormatter#F_INCLUDE_COMMENTS needs improvement
Summary: [formatter] javadoc of CodeFormatter#F_INCLUDE_COMMENTS needs improvement
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.4   Edit
Hardware: PC Windows XP
: P3 minor (vote)
Target Milestone: 3.6 M1   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-06-03 06:04 EDT by Eric Jodet CLA
Modified: 2009-08-03 09:58 EDT (History)
1 user (show)

See Also:


Attachments
Proposed patch (1.83 KB, patch)
2009-06-25 09:58 EDT, Frederic Fusier CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Eric Jodet CLA 2008-06-03 06:04:08 EDT
3.4RC3 - Build id: I20080530-1730

The doc currently reads:
(...)
* Note also that it has an effect only when the option
* {@link DefaultCodeFormatterConstants#FORMATTER_COMMENT_FORMAT_JAVADOC_COMMENT}
* is set to {@link DefaultCodeFormatterConstants#TRUE} while calling
(...)

The javadoc comment should reflect the fact that now, both single and multi line comments can also be formatted on the fly by the integrated comment formatter:
{@link DefaultCodeFormatterConstants#FORMATTER_COMMENT_FORMAT_JAVADOC_COMMENT}
{@link DefaultCodeFormatterConstants#FORMATTER_COMMENT_FORMAT_BLOCK_COMMENT}
{@link DefaultCodeFormatterConstants#FORMATTER_COMMENT_FORMAT_LINE_COMMENT}
Comment 1 Frederic Fusier CLA 2009-06-25 09:58:19 EDT
Created attachment 140096 [details]
Proposed patch
Comment 2 Frederic Fusier CLA 2009-06-25 09:59:47 EDT
Released for 3.6M1 in HEAD stream.
Comment 3 Ayushman Jain CLA 2009-08-03 08:52:45 EDT
Verified for 3.6M1 using build I20090802-2000