]> git.ipfire.org Git - thirdparty/freeswitch.git/commit
docs: Major clean up of doxygen generated core API documentation
authorStefan Knoblich <s.knoblich@axsentis.de>
Fri, 17 Jun 2011 22:25:38 +0000 (00:25 +0200)
committerStefan Knoblich <s.knoblich@axsentis.de>
Fri, 17 Jun 2011 22:43:53 +0000 (00:43 +0200)
commit794246e1d140d29e6acf0aaf7a3620cba1f0ce87
tree20cc140ba32707f75ac1fffcf20f65e538bffbdb
parent0128bce4ac222c6e0ee17ee9f89b63678ff8cf97
docs: Major clean up of doxygen generated core API documentation

To make the API documentation usable (again):

  - Rename to "FreeSWITCH API Documentation"

  - Remove all external INPUT paths, only scan FreeSWITCH core sources

  - Only parse a sane subset of files: *.c *.cc *.cpp *.h *.hh *.hxx
    (don't care about any python / whatever files for now)

  - Exclude modules (seriously, all the mod_java / mod_managed stuff
    turned it into an unusable mess. You need API docs of modules? Add separate doxygen
    configurations for them (or specific ones))

  - Include src/mod in example search path (for @include etc.), add C/C++
    patterns.

  - Set up PREDEFINED to fix the massive clusterf*ck that was caused by
    SWITCH_DECLARE() and friends.

<End Of Rant>

Signed-off-by: Stefan Knoblich <s.knoblich@axsentis.de>
docs/Doxygen.conf