Contents

Documentation generator

Software tool

This article needs additional citations for verification. Please help improve this articlebyadding citations to reliable sources. Unsourced material may be challenged and removed. Find sources: "Documentation generator" – news · newspapers · books · scholar · JSTOR (December 2009) (Learn how and when to remove this message)

Adocumentation generator is a programming tool that generates software documentation intended for programmers (API documentation) or end users (end-user guide), or both, from a set of source code files, and in some cases, binary files. Some generators, such as Javadoc, can use special comments to drive the generation. Doxygen is an example of a generator that can use all of these methods.

Types of generation[edit]

Document generation can be divided in several types:

• Batch generation (generic technique)
• Text block correspondence (documents created based on pre-defined text blocks)
• Forms (forms for websites)
• Documentation synthesis:
  • Documentation can be inferred from code
  • Documentation can be inferred from execution traces^[1]

Some integrated development environments provide interactive access to documentation, code metadata, etc.

See also[edit]

• Comparison of documentation generators
• Template processor
• Static code analysis
• Literate programming
• Integrated development environment

References[edit]

This article related to a type of software is a stub. You can help Wikipedia by expanding it.