SourceForge.net Logo
JAutodoc - Eclipse Plugin
JAutodoc is an Eclipse Plugin for automatically adding Javadoc and file headers to your source code. It optionally generates initial comments from element name by using Velocity templates for Javadoc and file headers.

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.

Options

Tag Order

Configuration of Javadoc tag order.

File Header

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.




Usage

  • For source files opened in Editor Javadoc can be added for all or only for selected members. In this case the modified source file will not be saved automatically to disk.

    If the cursor is inside the declaration of an field or method, only this element will be documented. To create a type comment point to the name of the type. Otherwise all members of the current source file will be documented.

    Selecting the menus with "..." will open an Options Dialog where it's possible to overrule the current project/workspace settings. These settings will only be effective for the current compilation unit and only for this Eclipse session.

  • In Package Explorer you can select one or more source file(s) in order to add Javadoc. Alternatively, you can select a package and add Javadoc for all package members or you can do it for the complete project.

    Caution: Source files which are not opened in the editor will be saved directly to disk.
  • When using the Options Dialog in Editor it's possible to see a Preview of all changes.



Task Search

JAutodoc allows to search for tasks like missing Javadoc, file headers or special tags.

Most of the options are self-explaining. Here's the rest:
  • Generated Javadoc
    Search for Javadoc comments that exactly match the one generated by JAutodoc.
  • Outdated file header
    Search for file headers that do not match the one generated by JAutodoc.
  • Search For Missing Tags
    Search for missing tags like @author. Add a minus to the tags name, if existing tags without message should not be reported or a plus, if only existing tags without message should be reported (e.g. @deprecated without a description).


Changes

  • 2014-01-12 Version 1.11.0
    • New options for [G,S]etter from field comment
    • Configuration dialog for Javadoc tag order
    • Some minor improvements
  • 2012-05-31 Version 1.10.0
    • Import/Export of the complete configuration from/to a single file
    • Recognition of global pre- and suffixes of fields for [G,S]etter
    • Support for evaluation of annotations in templates
    • Requires JRE 1.6
  • 2011-04-24 Version 1.9.0
    • New option: Exclude [G,S]etter
    • New option: Include subpackages when adding Javadoc for package members
    • Bugfix for {@inheritDoc}
    • Contribution to Eclipse help
  • 2010-08-12 Version 1.8.0
    • Preview Dialog
    • Automatic recognition of global parameter/field prefixes.
      (Preferences/Java/Code Style)
    • Support for package-info.java
    • Fixed html tag problem in return doc
  • 2010-03-28 Version 1.7.0
    • Search page for missing Javadoc and file headers
    • Requires Eclipse 3.4+
  • 2010-02-09 Version 1.6.0
    • Support for Eclipse 3.6
    • New option: [G,S]etter from field comment
    • Support for Generics
    • Escaping of # in templates by \#
    • Fixed encoding problems.
    • Some minor fixes and improvements.
    • Requires JRE 1.5 and Eclipse 3.3+
  • 2007-09-09 Version 1.5.0
    • Enhanced prefix/keyword replacement.
    • Escaping of dollar signs in templates by \$
    • Support for Package Javadoc.
  • 2007-07-10 Version 1.4.0
    • Project specific settings.
    • Temporary settings for single compilation units.
    • Ant task for Eclipse.
    • Support for multi comment headers.
    • General improvements for Eclipse 3.3
  • 2007-05-01 Version 1.3.0
    • Using Velocity templates for Header and Javadoc.
    • Template variables (e.g. $user, $date, $project_name, ...)
    • Context menu for adding Header only.
    • Filter options for Types, Fields, Methods and Getter/Setter.
    • Corrected order of parameter documentation.
    • Improvement for non-Javadoc.
    • Support for {@inheritDoc}.
    • New Update Site http://jautodoc.sourceforge.net/update/
  • 2007-01-05: Version 1.2.0
    • Consider member visibility.
    • Use non-Javadoc for inherited methods.
    • Editor shortcut Ctrl-Alt-J.
    • Selection model in editor changed.
    • Prefix replacement for fields and parameters.
  • 2006-10-20: Version 1.1.0
    • Single line field comments.
    • Use Eclipse comment formatter.
    • Add/Replace file header.
  • 2006-08-20: Version 1.0.0
    • Initial version.

License

JAutodoc is licensed under the Eclipse Public License - v 1.0

JAutodoc comes with the Velocity Template Engine 1.5, which is available under the Apache Software License - v 2.0



Download and Installation

Download JAutodoc here and unzip the file to the Eclipse directory or use the Update Site

http://jautodoc.sourceforge.net/update/



Contact

JAutodoc is written by Martin Kesting.