IntelliJ Community . JavaDocFormatterPlugin

 
JavaDocFormatterPlugin 

HOME INDEX SEARCH CHANGES GO  

JavaDoc Formatter

Introduction

Inspired by the AutoFormatText plug-in this plug-in reformats JavaDoc comments. It rewraps the comments and aligns the parameters.

Installation

Copy the jar file to your IDEA/plugins directory.

Activation

Move the cursor to the JavaDoc comment you want to reformat and press Ctrl-Alt-D.

Versions

  • Novmeber 15, 2002: Version 0.4
  • November 11, 2002: Version 0.3
    • Preserve empty lines in JavaDoc
    • Configurable parameter alignment
  • November 8, 2002: Version 0.2
    • Bugfixes
  • November 6, 2002: Version 0.1
    • Initial version

-- DarioZogg - 06 Nov 2002

Comments

  • great work wink -- RahelLuethy - 09 Nov 2002
  • Nice indeed smile Suggestions:
    • Preserve empty lines in javadocs
    • Even better, when dealing with a white line look for a <P> tag and if none is found, add it wink
    • Invoking JavaDocFormatterPlugin? in a non-javadoc comment generates an NPE.
    • Oh, and it lines up the description text after @param tags very far on the right.. Maybe it could figure out what the longest parameter is in the list and align based on that wink -- VinceMallet - 11 Nov 2002
  • Yes, this seems like a very useful plugin. Just a couple of additional suggestions to make it even better, in case you have nothing else to do smile
    • Special treatment for <PRE>...</PRE>: Don't reformat it at all.
    • Special treatment for HTML lists, such as <UL> <LI> first bullet <LI> second bullet ... </LI> -- right now the plugin messes up my lists. This could be formatted with each tag starting its own new line (<UL>, <LI>, ..., </UL>).
    • Extend it to make it work on ordinary block comments too
    • Extend it to make it work on consecutive lines of line comments
    • Make it possible to run it on an entire Java file
    • Make it possible to run it on an entire directory, like "Reformat Code"
    • Add an option not to break lines inside {@link ...}
    • -- JonasKvarnstrom - 25 Nov 2002

IntelliJPluginWebForm
IntelliJPluginName:
IntelliJPluginVersion:
IntelliJPluginVendor:
IntelliJPluginBinary:
IntelliJPluginSource:
IntelliJPluginClassification:
TopicClassification: IntelliJPluginArchive
TopicShortDescription: Inspired by the AutoFormatText plug-in this plug-in reformats JavaDoc comments. It rewraps the comments and aligns the parameters.
TestedOnOS:
ShouldRunOnOS:

Attachment: sort Action: Size: Date: Who: Comment:
jdf-0.4.jar action 17226 22 Nov 2002 - 10:54 DarioZogg  
JDFSrc-0.4.jar action 30257 22 Nov 2002 - 10:55 DarioZogg  

e d i t a t t a c h r e f - b y d i f f s m o r e
Have ideas, requests, problems regarding this site? Send feedback.
Copyright © 2000-2003 by the contributing authors. All materials at intellij.org are the property of the contributing authors.