• Home
• News
• Open-Source
• About

• Overview
• jax-doclets
• RESTEasy module
• RESTEasy-CRUD module
• Secure Permissions module
• Debian module
• LESS module
• Navigation module

jax-doclets

jax-doclets v0.10.0

About

jax-doclets allows you to generate JavaDoc documentation for specific Java annotation-based extensions. jax-doclets includes support for:

• JAX-RS: the RESTful API for Java
• JAXB: the XML binding API for Java
• JPA: the Java Persistence API

This is done by implementing a custom doclet for each API which is then used by the traditional javadoc command to generate the documentation.

Examples

You can see the JavaDoc files generated by our doclets on example APIs:

• JAX-RS API documentation
• JAXB documentation
• JPA documentation

Download

https://github.com/FroMage/jax-doclets/downloads

Usage

jax-doclets usage

User guide

• jax-doclets 0.10.0 user guide (HTML single page)
• jax-doclets 0.10.0 user guide (PDF)

Source code

https://github.com/FroMage/jax-doclets

Road map

In the future we will be adding support for at least the following APIs:

• Hibernate Search: a full-text indexing API for Java
• Bean Validation: the validation API for Java

Version history

Version history

Issues

Expect many, since this is pre-release quality. In particular, the standard doclet options are not all used (most of them aren’t to be honest).

https://github.com/FroMage/jax-doclets/issues