This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 11950 - Request Java indent engine have settings for Javadoc comments
Summary: Request Java indent engine have settings for Javadoc comments
Status: NEW
Alias: None
Product: java
Classification: Unclassified
Component: Javadoc (show other bugs)
Version: 3.x
Hardware: PC Linux
: P2 blocker (vote)
Assignee: Jan Becicka
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2001-05-04 12:15 UTC by Jesse Glick
Modified: 2011-01-13 13:18 UTC (History)
1 user (show)

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jesse Glick 2001-05-04 12:15:06 UTC
[Please close this if this kind of thing is already in the feature list for the
editor, or if it is not reasonable to do it.]

Desired feature for Java indentation engine: more control over
formatting of Javadoc comments. Specifically, (1) automatic line break
after end of summary sentence, and (2) keep comment all on one line if
only summary and no tags, as is typical for field Javadoc, e.g.:

    /** Some short comment. */

vs.:

    /** Longer summary sentence.
     * This has additional sentences.
     */

(alternately:)

    /** Longer summary sentence.
     * This has additional sentences. */

or this:

    /** Comment.
     * @return this is a separate line
     */

Also nice would be indenting of long tags:

    /** Comment.
     * @param listener A listener which you can attach if
     *                 you want to know about changes.
     * @return Some long complicated story about exactly
     *         what this could return in all cases.
     */

Of course <pre> blocks in Javadoc should be left untouched
in all cases.
Comment 1 David Konecny 2001-05-04 12:24:49 UTC
This is very reasonable enhancement. Thanx for it. There is already similar 
issue 11553, but it is only subset of this one, so I'm going to close it as 
duplicate.
Comment 2 Jan Chalupa 2001-05-05 21:54:16 UTC
Target milestone -> 3.3
Comment 3 David Konecny 2001-06-18 13:45:20 UTC
Changing the state of the issue to ASSIGNED, because it was covered in 
Requirements document at http://editor.netbeans.org/doc/Requirements.html
Comment 4 Jan Chalupa 2001-11-27 12:26:54 UTC
Target milestone -> 3.3.1.
Comment 5 Marian Petras 2002-06-07 08:12:38 UTC
According to
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#generalform,
format

    /**
     * Some comment.
     */

is preferred over 

    /** Some comment.
     */
Comment 6 Marek Grummich 2002-07-22 12:16:43 UTC
Set target milestone to TBD
Comment 7 Marek Grummich 2002-07-22 12:21:35 UTC
Set target milestone to TBD
Comment 8 psuk 2004-03-23 19:59:40 UTC
Changing subcomponent to "setting"


Comment 9 Vitezslav Stejskal 2008-01-10 12:45:38 UTC
Honzo, do you plan some work in this area?