JAutodoc

485

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

2023-12 (4.30), 2023-09 (4.29), 2023-06 (4.28), 2023-03 (4.27), 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), Mars (4.5), Luna (4.4), Kepler (4.3), 2024-03 (4.31), 2024-06 (4.32), 2024-09 (4.33)

https://mkesting.github.io/jautodoc-update/latest/

Learn more...

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. The main features are

Complete, keep or replace existing Javadoc
Create initial comments from element name
Getter/Setter comments from related field comment
Add/Replace file headers
Velocity templates for Javadoc and headers
Ant Task for Eclipse
Support for Package Javadoc
Search for missing Javadoc and file headers

Categories: Code Management, Documentation, Editor, IDE, Search

Tags: javadoc, templates, file header, velocity

Additional Details

Eclipse Versions: 2023-12 (4.30), 2023-09 (4.29), 2023-06 (4.28), 2023-03 (4.27), 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), Mars (4.5), Luna (4.4), Kepler (4.3), 2024-03 (4.31), 2024-06 (4.32), 2024-09 (4.33)

Platform Support: Windows, Mac, Linux/GTK

Organization Name: Martin Kesting

Development Status: Production/Stable

Date Created: Monday, August 21, 2006 - 10:11

License: EPL

Date Updated: Friday, December 29, 2023 - 15:57

Submitted by: Martin Kesting

Date	Ranking	Installs	Clickthroughs
October 2024	52/529	120	1
September 2024	55/642	603	16
August 2024	54/641	534	18
July 2024	54/663	536	18
June 2024	56/681	602	20
May 2024	61/682	627	21
April 2024	59/687	685	9
March 2024	52/694	861	11
February 2024	56/687	658	278
January 2024	60/691	709	18
December 2023	72/671	568	9
November 2023	60/686	760	14

View Data for all Listings

Unsuccessful Installs

Unsuccessful Installs in the last 7 Days: 5

Count	Error Message
5	Cannot continue the operation. There is another install operation in progress.

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 JAutodoc.

HTML Code:

Markdown Syntax:

Output:

Reviews Add new review

Export of preferences not working (Java 17, Eclipse 2022-03)

Submitted by Andre Sudhoff on Mon, 03/21/2022 - 07:33

I'm running Eclispe 2022-03 with Java 17.0.2 and try to export JAutoDoc preferences (Export All) which is not working. The following exception is thrown:

java.lang.NoClassDefFoundError: Could not initialize class com.sun.xml.bind.v2.runtime.reflect.opt.Injector
    at com.sun.xml.bind.v2.runtime.reflect.opt.AccessorInjector.prepare(AccessorInjector.java:41)
    at com.sun.xml.bind.v2.runtime.reflect.opt.OptimizedAccessorFactory.get(OptimizedAccessorFactory.java:77)
    at com.sun.xml.bind.v2.runtime.reflect.Accessor$GetterSetterReflection.optimize(Accessor.java:317)
    at com.sun.xml.bind.v2.runtime.property.SingleElementNodeProperty.<init>SingleElementNodeProperty.java:52)
    at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
...
    at javax.xml.bind.JAXBContext.newInstance(JAXBContext.java:522)
    at net.sf.jautodoc.utils.JAXBSerializer.doExport(JAXBSerializer.java:43)
    at net.sf.jautodoc.preferences.PreferenceSerializer.doExport(PreferenceSerializer.java:40)
    at net.sf.jautodoc.preferences.MainPreferencePage.performExport(MainPreferencePage.java:478)
    at net.sf.jautodoc.preferences.MainPreferencePage.access$2(MainPreferencePage.java:467)
    at net.sf.jautodoc.preferences.MainPreferencePage$3.widgetSelected(MainPreferencePage.java:187)
...

Re: Export of preferences not working (Java 17, Eclipse 2022-03)

Submitted by Martin Kesting on Mon, 03/21/2022 - 18:56

It’s because Java 17 denies all illegal access operations by default. Adding the following line to the end of eclipse.ini should solve the problem:

--add-opens=java.base/java.lang=ALL-UNNAMED

Can't export preferences with Java > 8

Submitted by Giovanni Lovato on Wed, 03/20/2019 - 04:20

Running Eclipse with Java > 8 (I'm on Java 11) when trying to export JAutodoc preferences to XML this exception is thrown:

java.lang.NoClassDefFoundError: javax/xml/bind/JAXBContext
	at net.sf.jautodoc.utils.JAXBSerializer.doExport(JAXBSerializer.java:43)
	at net.sf.jautodoc.preferences.PreferenceSerializer.doExport(PreferenceSerializer.java:40)
	at net.sf.jautodoc.preferences.MainPreferencePage.performExport(MainPreferencePage.java:478)
	at net.sf.jautodoc.preferences.MainPreferencePage.access$2(MainPreferencePage.java:467)
	at net.sf.jautodoc.preferences.MainPreferencePage$3.widgetSelected(MainPreferencePage.java:187)

Re: Can't export preferences with Java > 8

Submitted by Martin Kesting on Wed, 03/27/2019 - 18:33

Fixed with new version 1.14.1

Not available in 2019-03 M2

Submitted by Giovanni Lovato on Thu, 02/21/2019 - 02:16

Great integration of JAutodoc with Eclipse! I'm testing 2019-03 M2 right now, and unfortunately, the plugin isn't available in the Marketplace.

Re: Not available in 2019-03 M2

Submitted by Martin Kesting on Sat, 03/02/2019 - 14:01

Should be available now.

Re: Not available in 2019-03 M2

Submitted by Martin Kesting on Sun, 03/03/2019 - 14:57

... and thanks for reporting. New Eclipse versions have to be explicitly enabled for the plugin in the Marketplace. I wasn’t aware of that.

Error in installing JAutoDoc in Photon

Submitted by Ashok Ram on Wed, 08/15/2018 - 03:38

Hi,

Please check I am getting this below error message while intalling the JAutoDoc

An error occurred while installing the items
session context was:(profile=_Users_ashokram_Ashok_Applications_Eclipse.app_Contents_Eclipse, phase=org.eclipse.equinox.internal.p2.engine.phases.Install, operand=null --> [R]net.sf.jautodoc 1.14.0, action=org.eclipse.equinox.internal.p2.touchpoint.eclipse.actions.InstallBundleAction).
Could not acquire the framework manipulator service.
Could not acquire the framework manipulator service.

Environment

Mac - 10.13.6
Eclipse Version - Oxygen.3a Release (4.7.3a), Build id: 20180405-1200

Re: Error in installing JAutoDoc in Photon

Submitted by Martin Kesting on Thu, 08/16/2018 - 15:56

Sorry, but this doesn't seems to be a problem of JAutodoc. Looks like a general problem of your Eclipse installation: "Could not acquire the framework manipulator service". Are you able to install other plugins?

A useful deflector for agressive checkstyle rules

Submitted by Ed Randall on Mon, 12/12/2016 - 12:01

A useful tool, in so far as it goes.
In my experience this tool is used to save time with satisfying some corresponding Checkstyle rules.
Beware that mindlessly generating Javadoc comments on otherwise documented classes adds little, if any, value. Developers need to learn to actually write some *meaningful* comments in the generated fields, but very few do so.

A link from the marketplace description above, into the actual JAutodoc site jautodoc.sourceforge.net would not go amiss.