Documentation Generators
Documentation generators produce API documentation
- input: code containing comments with embedded "markup"
- output: typically HTML, but also other formats (e.g. LaTeX)
- output contains linked descriptions of
- modules/classes: overview, authorship, ...
- functions/methods: overview, params, result
- types: overview, structure
Examples:
- doxygen for C, C++, Java, Python, PHP, ...
- JavaDoc for Java, JSdoc for JavaScript, ...
|
![[prev]](icon/prev.gif){kind=icon}
![[index]](icon/up.gif){kind=icon}
![[next]](icon/next.gif){kind=icon}