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 201807 - "Add two blanks after leading star" option
Summary: "Add two blanks after leading star" option
Status: NEW
Alias: None
Product: java
Classification: Unclassified
Component: Javadoc (show other bugs)
Version: 7.1
Hardware: PC Windows XP
: P3 normal with 2 votes (vote)
Assignee: Jan Becicka
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-09-08 11:12 UTC by matthies
Modified: 2011-09-08 11:12 UTC (History)
0 users

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 matthies 2011-09-08 11:12:45 UTC
This is in relation to http://wiki.netbeans.org/NewAndNoteworthyNB71#Javadoc_Highlighting_and_Formatting. There is a Javadoc formatting style that uses two blanks instead of just one after the leading star at the start of a line, e.g.:

/**
 *  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
 *  Aenean rutrum malesuada diam, id scelerisque metus vehicula sed.
 *  Donec ut interdum orci. Ut varius enim id metus tristique fringilla.
 *
 *  <blockquote>
 *      <ul>
 *          <li>Item 1</li>
 *          <li>Item 2</li>
 *      </ul>
 *  </blockquote>
 *
 *  @param foo     Sed eget justo id nulla feugiat porta a sed augue. 
 *  @return        Vestibulum in lorem orci, non interdum arcu.
 */

This style has the benefit that the text lines start at multiples of four (assuming that the "/**" starts at a multiple of four), i.e. the usual tabbing positions. Indentations within the javadoc content (using the Tab key), like the list items in the above example, are thus consistent with the left alignment column of the text, and are always four columns.
(The larger space between leading star and text arguably makes the text easier to read as well.)

It would be nice if the javadoc formatting feature would support that style with an option "Add two blanks after leading star".