Jump to content

Doclet

From Wikipedia, the free encyclopedia

This is an old revision of this page, as edited by Jonathanhult (talk | contribs) at 04:19, 19 December 2017 (Adding latest Oracle Javadoc links; updating external links; updating formatting). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

Doclet programs work with the Javadoc tool to generate documentation from code written in Java.

Doclets are written in the Java programming language and use the Doclet API to:

  • Select which content to include in the documentation
  • Format the presentation of the content
  • Create the file that contains the documentation

The StandardDoclet[1] included with Javadoc generates API documentation as frame-based HTML files. Many non-standard doclets are available on the web [citation needed], often for free. These can be used to:

  • Create other non-API types of documentation
  • Output the documentation to other non-HTML file types such as PDF
  • Output the documentation as HTML with additional features such as a search or with embedded UML diagrams generated from the Java classes

External links