JavaDocFormatterPlugin 

HOME INDEX SEARCH GO  

 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.17 - 28 Nov 2003 - AlessandroVernet)
Changed:
<
<

Inspired by the FreeTextWrapper? plug-in this plug-in reformats JavaDoc comments.

>
>

Inspired by the AutoFormatText plug-in this plug-in reformats JavaDoc comments.

Changed:
<
<

%META:FIELD{name="TopicShortDescription" title="TopicShortDescription" value="Inspired by the FreeTextWrapper? plug-in this plug-in reformats JavaDoc comments. It rewraps the comments and aligns the parameters.%_N_%"}%

>
>

%META:FIELD{name="TopicShortDescription" title="TopicShortDescription" value="Inspired by the AutoFormatText plug-in this plug-in reformats JavaDoc comments. It rewraps the comments and aligns the parameters.%_N_%"}%


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.16 - 18 Jun 2003 - AlexeyEfimov)
Changed:
<
<

%META:FIELD{name="TopicClassification" title="TopicClassification" value="IntelliJPluginPackage"}%

>
>

%META:FIELD{name="TopicClassification" title="TopicClassification" value="IntelliJPluginArchive"}%


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.15 - 19 May 2003 - AlexeyEfimov)
Changed:
<
<

%META:FORM{name="WebForm"}%

>
>

%META:FORM{name="IntelliJPluginWebForm"}% %META:FIELD{name="IntelliJPluginName" title="IntelliJPluginName" value=""}% %META:FIELD{name="IntelliJPluginVersion" title="IntelliJPluginVersion" value=""}% %META:FIELD{name="IntelliJPluginVendor" title="IntelliJPluginVendor" value=""}% %META:FIELD{name="IntelliJPluginBinary" title="IntelliJPluginBinary" value=""}% %META:FIELD{name="IntelliJPluginSource" title="IntelliJPluginSource" value=""}% %META:FIELD{name="IntelliJPluginClassification" title="IntelliJPluginClassification" value=""}%


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.14 - 02 Dec 2002 - AlexeyEfimov)
Changed:
<
<

%META:FORM{name="PluginWebForm"}%

>
>

%META:FORM{name="WebForm"}%


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.13 - 29 Nov 2002 - AlexeyEfimov)
Added:
>
>

%META:FORM{name="PluginWebForm"}% %META:FIELD{name="TopicClassification" title="TopicClassification" value="IntelliJPluginPackage"}% %META:FIELD{name="TopicShortDescription" title="TopicShortDescription" value="Inspired by the FreeTextWrapper? plug-in this plug-in reformats JavaDoc comments. It rewraps the comments and aligns the parameters.%_N_%"}% %META:FIELD{name="TestedOnOS" title="TestedOnOS" value=""}% %META:FIELD{name="ShouldRunOnOS" title="ShouldRunOnOS" value=""}%


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.12 - 25 Nov 2002 - JonasKvarnstrom)
Changed:
<
<

>
>

  • 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

 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.11 - 22 Nov 2002 - DarioZogg)
Changed:
<
<

%META:FILEATTACHMENT{name="jdf-plugin-0.2.jar" attr="" comment="" date="1036755100" path="D:\IntelliJ_IDEA_3.0\plugins\jdf-plugin-0.2.jar" size="12517" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="JDFSrc-0.2.zip" attr="" comment="" date="1036755145" path="E:\Sources\JDFDev\JDFSrc-0.2.zip" size="12420" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="jdf-plugin-0.3.jar" attr="" comment="" date="1037021795" path="D:\IntelliJ_IDEA_3.0\plugins\jdf-plugin-0.3.jar" size="16557" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="JDFSrc-0.3.zip" attr="" comment="" date="1037022422" path="E:\Sources\JDFDev\JDFSrc-0.3.zip" size="15046" user="DarioZogg" version="1.1"}%

>
>

%META:FILEATTACHMENT{name="jdf-plugin-0.2.jar" attr="h" comment="" date="1036755100" path="D:\IntelliJ_IDEA_3.0\plugins\jdf-plugin-0.2.jar" size="12517" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="JDFSrc-0.2.zip" attr="h" comment="" date="1036755145" path="E:\Sources\JDFDev\JDFSrc-0.2.zip" size="12420" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="jdf-plugin-0.3.jar" attr="h" comment="" date="1037021795" path="D:\IntelliJ_IDEA_3.0\plugins\jdf-plugin-0.3.jar" size="16557" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="JDFSrc-0.3.zip" attr="h" comment="" date="1037022422" path="E:\Sources\JDFDev\JDFSrc-0.3.zip" size="15046" user="DarioZogg" version="1.1"}%

Changed:
<
<

%META:FILEATTACHMENT{name="JDFSrc-0.4.zip" attr="" comment="" date="1037354478" path="E:\Sources\JDFDev\JDFSrc-0.4.zip" size="15826" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="jdf-plugin-0.4.jar" attr="" comment="" date="1037354490" path="E:\Sources\JDFDev\classes\jdf-plugin-0.4.jar" size="16788" user="DarioZogg" version="1.1"}%

>
>

%META:FILEATTACHMENT{name="JDFSrc-0.4.zip" attr="h" comment="" date="1037354478" path="E:\Sources\JDFDev\JDFSrc-0.4.zip" size="15826" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="jdf-plugin-0.4.jar" attr="h" comment="" date="1037354490" path="E:\Sources\JDFDev\classes\jdf-plugin-0.4.jar" size="16788" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="jdf-0.4.jar" attr="" comment="" date="1037962494" path="E:\Sources\JDFDev\jdf-0.4.jar" size="17226" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="JDFSrc-0.4.jar" attr="" comment="" date="1037962506" path="E:\Sources\JDFDev\JDFSrc-0.4.jar" size="30257" user="DarioZogg" version="1.1"}%


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.10 - 15 Nov 2002 - DarioZogg)
Changed:
<
<

  • November 11, 2002: Improved version 0.3
>
>

  • Novmeber 15, 2002: Version 0.4
  • November 11, 2002: Version 0.3
Changed:
<
<

  • November 8, 2002: Bugfixed version 0.2
  • November 6, 2002: Initial version 0.1

>
>

  • November 8, 2002: Version 0.2
    • Bugfixes
  • November 6, 2002: Version 0.1
    • Initial version
Added:
>
>

%META:FILEATTACHMENT{name="JDFSrc-0.4.zip" attr="" comment="" date="1037354478" path="E:\Sources\JDFDev\JDFSrc-0.4.zip" size="15826" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="jdf-plugin-0.4.jar" attr="" comment="" date="1037354490" path="E:\Sources\JDFDev\classes\jdf-plugin-0.4.jar" size="16788" user="DarioZogg" version="1.1"}%


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.9 - 13 Nov 2002 - DarioZogg)
Deleted:
<
<

Note For Dario

I've attached a file "jdf-0.3-hacked-by-vim.zip" which contains a brutalized version of Parser.java. I've done three things:

  • fixed the problem where Parser would skip the parameter if there were two or more spaces between the keyword and the parameter
  • helped Parser not introduce a "<p>" if there was already a <p> on the previous line (even at the end of a text line) (that's more a hack than anything)
  • played a little too much with Extract Method and Introduce Field on parse(), just so I could understand what parse() was doing wink
Please feel free to trash/update/integrate/ignore the file. Also, I'm email impaired right now so I'm using a note here instead. Remove this note as you see fit. -- VinceMallet - 13 Nov 2002

 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.8 - 13 Nov 2002 - VinceMallet)
Added:
>
>

Note For Dario

I've attached a file "jdf-0.3-hacked-by-vim.zip" which contains a brutalized version of Parser.java. I've done three things:

  • fixed the problem where Parser would skip the parameter if there were two or more spaces between the keyword and the parameter
  • helped Parser not introduce a "<p>" if there was already a <p> on the previous line (even at the end of a text line) (that's more a hack than anything)
  • played a little too much with Extract Method and Introduce Field on parse(), just so I could understand what parse() was doing wink
Please feel free to trash/update/integrate/ignore the file. Also, I'm email impaired right now so I'm using a note here instead. Remove this note as you see fit. -- VinceMallet - 13 Nov 2002

Added:
>
>

%META:FILEATTACHMENT{name="jdf-0.3-hacked-by-vim.zip" attr="h" comment="See my note on the plugin page" date="1037149403" path="D:\Vince\idea\JDF\jdf-0.3-hacked-by-vim.zip" size="3279" user="VinceMallet" version="1.1"}%


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.7 - 11 Nov 2002 - DarioZogg)
Changed:
<
<

    • Preserve empty in lines in JavaDoc
>
>

    • Preserve empty lines in JavaDoc

 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.6 - 11 Nov 2002 - DarioZogg)
Changed:
<
<

  • November 9, 2002: Bugfixed version 0.2
>
>

  • November 11, 2002: Improved version 0.3
    • Preserve empty in lines in JavaDoc
    • Configurable parameter alignment
  • November 8, 2002: Bugfixed version 0.2
Added:
>
>

%META:FILEATTACHMENT{name="jdf-plugin-0.3.jar" attr="" comment="" date="1037021795" path="D:\IntelliJ_IDEA_3.0\plugins\jdf-plugin-0.3.jar" size="16557" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="JDFSrc-0.3.zip" attr="" comment="" date="1037022422" path="E:\Sources\JDFDev\JDFSrc-0.3.zip" size="15046" user="DarioZogg" version="1.1"}%


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.5 - 11 Nov 2002 - DarioZogg)
Added:
>
>

  • November 9, 2002: Bugfixed version 0.2
Added:
>
>


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.4 - 10 Nov 2002 - VinceMallet)
Changed:
<
<

>
>

  • 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

 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.3 - 09 Nov 2002 - RahelLuethy)
Added:
>
>

Comments


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.2 - 08 Nov 2002 - DarioZogg)
Changed:
<
<

%META:FILEATTACHMENT{name="jdf-plugin-0.1.jar" attr="" comment="" date="1036600041" path="E:\Sources\JDFDev\classes\jdf-plugin-0.1.jar" size="12500" user="DarioZogg" version="1.1"}%

>
>

%META:FILEATTACHMENT{name="jdf-plugin-0.1.jar" attr="h" comment="" date="1036600041" path="E:\Sources\JDFDev\classes\jdf-plugin-0.1.jar" size="12500" user="DarioZogg" version="1.1"}%

Changed:
<
<

%META:FILEATTACHMENT{name="JDFSrc-0.1.zip" attr="" comment="" date="1036600370" path="E:\Sources\JDFDev\JDFSrc-0.1.zip" size="12406" user="DarioZogg" version="1.1"}%

>
>

%META:FILEATTACHMENT{name="JDFSrc-0.1.zip" attr="h" comment="" date="1036600370" path="E:\Sources\JDFDev\JDFSrc-0.1.zip" size="12406" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="jdf-plugin-0.2.jar" attr="" comment="" date="1036755100" path="D:\IntelliJ_IDEA_3.0\plugins\jdf-plugin-0.2.jar" size="12517" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="JDFSrc-0.2.zip" attr="" comment="" date="1036755145" path="E:\Sources\JDFDev\JDFSrc-0.2.zip" size="12420" user="DarioZogg" version="1.1"}%


 <<O>>  Difference Topic JavaDocFormatterPlugin (r1.1 - 06 Nov 2002 - DarioZogg)
Added:
>
>

%META:TOPICINFO{author="DarioZogg" date="1036600620" format="1.0" version="1.1"}% %META:TOPICPARENT{name="WebHome"}%

JavaDoc Formatter

Introduction

Inspired by the FreeTextWrapper? 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

  • November 6, 2002: Initial version 0.1

-- DarioZogg - 06 Nov 2002

%META:FILEATTACHMENT{name="jdf-plugin-0.1.jar" attr="" comment="" date="1036600041" path="E:\Sources\JDFDev\classes\jdf-plugin-0.1.jar" size="12500" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="JDFSrc.zip" attr="h" comment="" date="1036600308" path="E:\Sources\JDFDev\JDFSrc.zip" size="12406" user="DarioZogg" version="1.1"}% %META:FILEATTACHMENT{name="JDFSrc-0.1.zip" attr="" comment="" date="1036600370" path="E:\Sources\JDFDev\JDFSrc-0.1.zip" size="12406" user="DarioZogg" version="1.1"}%


View | Diffs | r1.17 | > | r1.16 | > | r1.15 | More

e d i t a t t a c h r e f - b y d i f f s
Ideas,requests,problems regarding this site? Send feedback.
Copyright @ 2000-2003 by the contribution authors. All material on this collaboration tool is the property of the contributing authors.

Revision r1.1 - 06 Nov 2002 - 16:37 GMT - DarioZogg
Revision r1.17 - 28 Nov 2003 - 01:46 GMT - AlessandroVernet 		Copyright © 2001 by the contributing authors. All material on this collaboration tool is the property of the contributing authors.
Ideas, requests, problems regarding this site? Send feedback.