Features

JAutodoc has the following features:

Mode

• Complete existing Javadoc
  
  Existing Javadoc will not be touched. Only missing tags will be added and so far undocumented elements will be documented.
  
  
• Keep existing Javadoc
  
  Existing Javadoc will not be touched. Missing tags will not be added, but so far undocumented elements will be documented.
  
  
• Replace existing Javadoc
  
  Existing Javadoc will be totally replaced by the generated Javadoc. Be sure, if you use this option.

Visibility

• Public, protected, package or private
  
  Decide for which visibilities you like to create Javadoc.

Filter

• Comment Types, Fields, Methods or Getter/Setter only
  
  Decide for which kind of members you like to create Javadoc.

Markdown (Java 23 required)

• Use Markdown
  
  Use Markdown for new comments.
  
  
• Change existing comments
  
  Existing Javadoc will be switched to Markdown comment style and vice versa, depending on the previous option.

Options

• Add ToDo for auto-generated Javadoc
  
  Add ToDo flag in order to find all sources with auto-generated Javadoc. This is done once only for a source file.

  

• Create comment from element name
  With this option checked JAutodoc will generate comments from element name as shown below. Templates can be used, to define how this comments will be created. Additionally for fields, methods and parameters shortcut Replacements can be defined.

  Fields:

  

  Methods:

  

• Single line field comment
  
  Option to create single line field comments.

  

• Use Eclipse comment formatter
  
  Use Eclipse internal formatter to format the generated comments. The format can be defined under the preferences of

  

• [G,S]etter from field comment
  
  Create Getter/Setter comments from related field comment.
  
  

  • First sentence only
    Use first sentence only or complete field comment.
    
  • Replace existing [G,S]etter
    Replace or keep existing [G,S]etter comment.
    

• Include subpackages
  
  Include subpackages when adding Javadoc for package members.

Tag Order

Configuration of Javadoc tag order.

File Header

• Add/Replace file header
  
  You can specify a file header that will be added to your source, if no header exists. Optionally, existing headers can be replaced. With option Multi comment header checked, multiple comments at the beginning of the source can be replaced.

  Inside header text the Velocity Template Language (VTL) and pre-defined Variables can be used.

  

  Note: In order to use dollar signs inside the header template (e.g. for SVN/CVS properties like $id$) you have to escpape these signs by an backslash (\$).

Package Javadoc

• Edit Template You can specify the initial content of package.html or package-info.java, which can be added via context menu of package nodes in the Package Explorer.

  

  Like for headers the Velocity Template Language (VTL) and pre-defined Variables can be used inside the template.

• Use package-info.java Use package-info.java instead of package.html

Replacements

When creating comments from element name, shortcuts inside of fields, methods and parameters can be replaced by another text. For example "set" will be replaced by "Sets the" or "db" can be expanded to "Database".

These replacements can be added, deleted or changed via the preferences. The scope of an replacement can be "Field", "Method" or "Both". Use "Field" for fields and parameters. Optionally only the prefix (Prefix) or every occurrence (All) of the shortcut can be replaced.

Note: Shortcuts are case insensitive. They are detected by changes between upper and lower case letters inside the element name (e.g. setDbName).

Import/Export All...

Import/Export of the complete configuration from/to a single file.

Clean Up and Save Action for file headers

Add/Replace file headers on clean up or each save of the Java editor.