AccessorJavadoc

Add this URL to your Eclipse Installation to reach this solution's update site.

2022-12 (4.26), 2022-09 (4.25), 2022-06 (4.24), 2022-03 (4.23), 2021-12 (4.22), 2021-09 (4.21), 2021-06 (4.20), 2021-03 (4.19), 2020-12 (4.18), 2020-09 (4.17), 2020-06 (4.16), 2020-03 (4.15), 2019-12 (4.14), 2019-09 (4.13), 2019-06 (4.12), 2019-03 (4.11), 2018-12 (4.10), 2018-09 (4.9), Photon (4.8), Oxygen (4.7), Neon (4.6)

https://recyclebin5385.nobody.jp/software/software/accessorjavadoc/updates/latest/

Learn more...
Solution Description

An Eclipse plugin which generates Javadoc for getters and setters of a Java class. The generated Javadocs are based on those of fields corresponding to the getters or setters.

How to use

Open a Java source code with the Java Editor of Eclipse and move the cursor inside the class definition (an inner class can be selected).
Select "Javadoc -> Generate Getter/Setter Javadocs from Field Javadocs..." in the main menu of Eclipse or the context menu of the editor, and a dialog opens. The shortcut key is Ctrl+Shift+D.

In the dialog select getters and setters for which you want to generate Javadocs and click "OK" button. Javadocs are generated for the selected getters and setters. If Javadocs already exist, they are replaced by new ones.

If a tag "@accessorjavadoc.excluded" exists in an existing Javadoc of a getter or setter, it remains unselected when the dialog is displayed. This feature is convenient when you want to manually edit the Javadoc. 

Configuration

Select "Window→Preferences" in Eclipse's main menu and open Preferences dialog. 
Select "AccessorJavadoc" on the left side and the configurations are displayed.

Field name regex specifies the regular expression witch matches class variable names. 
Select a group with () and you can extract a variable name without a prefix and/or a suffix. Group #1 of the regular expression should be the whole part with the prefix and/or the suffix removed. 
No problem if the regular expression does not match class variable names, but prefixes and suffixes are not removed. 
ex. When you specify "(?:[ms]?_)(.+)", variable names are converted as follows: m_foo->foo, s_bar->bar, _baz->baz, qux->not converted

Getter summary template and Setter summary template specify texts used as the templates of the Javadoc summaries of a getter and a setter each.

@param NAME or @return template specifies the template of the description of the parameter of a getter or the return value of a setter. 
You can embed variables in these configurations. The format is ${variable name}.
Available variables are shown below.

  • label: The "label" of a variable; The first sentence of the Javadoc of a variable with the last period removed.
  • label.capitalized: The label with the first character upcased.
  • label.uncapitalized: The label with the first character downcased. (If there is a lower case other than the first character in the first word, it is regarded as an abbreviation and not downcased.)
  • label.toUpperCase: The upcased label.
  • label.toLowerCase: The downcased label.

Period characters specifies characers used as periods at the end of a sentence.

Categories: Documentation, Tools

Tags: javadoc

Additional Details

Eclipse Versions: 2022-12 (4.26), 2022-09 (4.25), 2022-06 (4.24), 2022-03 (4.23), 2021-12 (4.22), 2021-09 (4.21), 2021-06 (4.20), 2021-03 (4.19), 2020-12 (4.18), 2020-09 (4.17), 2020-06 (4.16), 2020-03 (4.15), 2019-12 (4.14), 2019-09 (4.13), 2019-06 (4.12), 2019-03 (4.11), 2018-12 (4.10), 2018-09 (4.9), Photon (4.8), Oxygen (4.7), Neon (4.6)

Platform Support: Windows, Mac, Linux/GTK

Development Status: Beta

Date Created: Sunday, April 30, 2017 - 07:12

License: BSD

Date Updated: Friday, January 27, 2023 - 08:03

Submitted by: recyclebin5385 Doe

Screenshot
Date Ranking Installs Clickthroughs
April 2024 356/645 15 9
March 2024 444/694 14 12
February 2024 388/687 20 12
January 2024 449/691 12 10
December 2023 440/671 13 11
November 2023 390/686 23 15
October 2023 368/673 27 14
September 2023 460/663 12 10
August 2023 416/673 15 9
July 2023 417/668 16 3
June 2023 351/669 28 5
May 2023 363/671 28 2
View Data for all Listings

Unsuccessful Installs

Unsuccessful Installs in the last 7 Days: 0

Download last 500 errors (CSV)

Marketplace Drag to Install Button

By adding the following code below to your website you will be able to add an install button for AccessorJavadoc.

HTML Code:

Markdown Syntax:

Output:

Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client

Reviews Add new review