Bug 60941 - Tool to reformat Javadoc to fit within line size soft limit
Tool to reformat Javadoc to fit within line size soft limit
Status: NEW
Product: java
Classification: Unclassified
Component: Javadoc
5.x
All All
: P2 with 3 votes (vote)
: 6.x
Assigned To: s28257902
issues@java
plan61
: NETFIX
Depends on: 20672
Blocks: 59545
  Show dependency treegraph
 
Reported: 2005-07-13 17:20 UTC by janicki
Modified: 2011-04-05 12:46 UTC (History)
4 users (show)

See Also:
Issue Type: ENHANCEMENT
:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description janicki 2005-07-13 17:20:09 UTC
This enhancement request is regarding javadoc blocks, especially those that are later edited causing the 
original line breaks to look ragged as lines are lengthened/shortened. 

Use "Text Limit Character Count" setting from the editor (the one that draws the subtle vertical line 
through the text editor) to reformat javadoc paragraphs to fit.  In the simplest case, just break up long 
lines.  More complicated reformatting would join short lines, but would need to respect any blank lines 
or single lines containing <p> or <br>?  Also, should consider indents for tags (@param, @return, etc.) 
that span multiple lines.

I think this tool should only act on the currently selected javadoc block, and optionally on the entire 
file.  Maybe as submenu choices under "Reformat Code"?

The relatively new feature to auto-prefix a "*" in javadoc line helps a lot, but this enhancement would 
further reduce unproductive programmer keystrokes.
Comment 1 _ moser 2007-05-02 09:26:20 UTC
In the latest dev builds, the "Refomat code" feature has been greatly improved.
Unfortunately it does nothing to javadoc, which is a must have in my eyes.
Line-wrapping, reordering params and inserting blank lines again and again must
be done manually or using external tools like Jalopy. Please consider to
implement this improvement in 6.0.

Also in my eyes this prblem is a "Highly visible usability problem" to allow P3
for this issue.
Comment 2 Jan Pokorsky 2007-10-24 14:51:26 UTC
Raising priority. I would like to target this in the next release. It should be implemented using the new Editor
Indentation API.
Comment 3 Jan Becicka 2008-06-25 15:46:35 UTC
Is it doable for 6.5?
Comment 4 kapitarg 2010-04-22 20:13:10 UTC
I'd like to NetFIX [1] this bug. Is it possible?

[1] http://wiki.netbeans.org/NetFIX"
Comment 5 Jiri Kovalsky 2010-04-26 18:30:52 UTC
Yes, Honza Lahoda promised to review and integrate your patch. Good luck Gabor!


By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo