In order to look for a new documentation tool for Beast, i set out a list of requirements that had to be matched: a) We need to generate reference documentation from C and C++ source code comments. b) Since we also need to process ordinary documentation files (say an FAQ) that involve lots of text and occasionally graphics, Tex-info syntax is to be preferred over XML-style markup (well - actually *anything* is preferable over XML-style markup for lots of human digestible text) if at all possible. c) We need to generate documentation from introspection tools (e.g. bseautodoc.c spews out documentation for object properties, signals and channels). d) The source code comments should use the same markup style that is used for ordinary documentation and design documents (e.g. the Beast FAQ or the Beast Quick Start Guide). e) We need to be able to generate decently looking HTML for the Beast website. f) We need to be able to generate manual pages - nothing too sophisticated, covering roughly the feature set o More
2011-06-10