Documentation generator

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search

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 Doxygen or Javadoc, use special comments to drive the generation.

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[1]
    • Documentation can be inferred from execution traces[2]
    • Documentation can be inferred from mailing lists[3]

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

References[edit]

  1. ^ Bruch, Marcel; Mezini, Mira; Monperrus, Martin (2010). "Mining subclassing directives to improve framework reuse". doi:10.1109/MSR.2010.5463347.
  2. ^ Zhang, Sai; Zhang, Cheng; Ernst, Michael (2011). "Automated documentation inference to explain failed tests". doi:10.1109/ASE.2011.6100145.
  3. ^ Hens, Stefan; Monperrus, Martin; Mezini, Mira (2012). "Semi-automatically extracting FAQs to improve accessibility of software development knowledge". doi:10.1109/ICSE.2012.6227139.

See also[edit]