Jump to content

Documentation generator

From Wikipedia, the free encyclopedia

A documentation 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]


  1. ^ Zhang, Sai; Zhang, Cheng; Ernst, Michael (2011). "Automated documentation inference to explain failed tests" (PDF). 2011 26th IEEE/ACM International Conference on Automated Software Engineering (ASE 2011). pp. 63–72. doi:10.1109/ASE.2011.6100145. ISBN 978-1-4577-1639-3. S2CID 14846118.