Skip to content

msbicer/APIDoclet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 

Repository files navigation

APIDoclet

APIDoclet is a Javadoc doclet for Java Web APIs. Aim of this project is to be able to generate user-friendly API documentation with ease. PDF and HTML outputs are supported.

Documentation is generated using Javadoc documentation and annotations. Thus standard Java documentation format is enough. Although there are some extra useful Javadoc tags:

Class level

  • @module <string> Entitle class with a module name
  • @ignore Do not include this class to documentation

Method level

  • @requestExample <string> Provide an example request format for method
  • @responseExample <string> Provide an example return format for method
  • @name <string> Provide an alternative name for method
  • @ignore Do not include this method to documentation

For now, only Spring MVC 3+ is supported. Supported annotations are:

Class level

Method level

Parameter level

Output Format

Documentation requirements differ from project to project. Hence output must be configurable and flexible. APIDoclet can generate output in PDF and HTML formats. A template file must be provided for this purpose. Documentation is generated using Freemarker, Flying Saucer and iText. Template must be in Freemarker format.

Sample Usage

javadoc -output test.pdf -template templates/test.ftl [-resources <resource_folder>] -doclet APIDoclet ...

You can also use APIDoclet in Maven! Please check example project for details.

For more details on using doclets, please check Doclet overview page

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published