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 228320 - new javadoc formatting option: description on new line
Summary: new javadoc formatting option: description on new line
Alias: None
Product: editor
Classification: Unclassified
Component: Formatting & Indentation (show other bugs)
Version: 7.4
Hardware: PC Mac OS X
: P4 normal (vote)
Assignee: Dusan Balek
Depends on:
Reported: 2013-04-06 01:36 UTC by athompson
Modified: 2016-07-07 16:23 UTC (History)
1 user (show)

See Also:
Exception Reporter:


Note You need to log in before you can comment on or make changes to this bug.
Description athompson 2013-04-06 01:36:49 UTC
The below method of formatting javadoc comments has achieved a (small) level of popularity due to its increased legibility:

 * Apply the foo algorithm to the specified Bar.
 * @param Bar
 * The Bar.
 * @param count
 * The number of times the algorithm should be applied
 * to the specified Bar. This must be a positive prime
 * number, except during a full moon, when the specified
 * value must be a member of the Fibonacci sequence.
 * @param quick
 * If TRUE, apply the "quick" (less accurate)
 * implementation of the algorithm. Note that sheep-style
 * Bar objects are currently not supported with the quick
 * implementation.
 * @return
 * The number of wizard levels gained while applying the
 * algorithm.
 * @throws FooException
 * If there was a problem applying the algorithm to the
 * specified Bar.
 * @author Alvin
public int foo(Bar bar, int count, boolean quick) throws FooException;

In order for Netbeans to be able to format comments in this manner, two new formatter settings are required. This issue covers the "descriptions on new line" setting, which would force all descriptions to start on a new line, instead of starting on the same line as the javadoc keyword/parameter name.
Comment 1 Martin Balin 2016-07-07 07:31:31 UTC
This old bug may not be relevant anymore. If you can still reproduce it in 8.2 development builds please reopen this issue.

Thanks for your cooperation,
NetBeans IDE 8.2 Release Boss
Comment 2 athompson 2016-07-07 16:23:13 UTC
Still there, but definitely not important. Feel free to close again if it's not worth the effort.