doc


Log

Author Commit Date CI Message
Ran Benita 40e5de9a 2013-03-05T12:01:48 doc: update Doxyfile template to one from newer version We want to use the USE_MDFILE_AS_MAINPAGE option which was introduced in doxygen 1.8.3 (released 2012-12). Right now the new options are commented, otherwise older doxygen spews these these warnings, which can be ignored: warning: ignoring unsupported tag `USE_MDFILE_AS_MAINPAGE =' at line 794, file doc/Doxyfile warning: ignoring unsupported tag `MATHJAX_FORMAT =' at line 1210, file doc/Doxyfile warning: ignoring unsupported tag `EXTERNAL_SEARCH =' at line 1257, file doc/Doxyfile warning: ignoring unsupported tag `SEARCHENGINE_URL =' at line 1265, file doc/Doxyfile warning: ignoring unsupported tag `SEARCHDATA_FILE =' at line 1271, file doc/Doxyfile warning: ignoring unsupported tag `EXTERNAL_SEARCH_ID =' at line 1278, file doc/Doxyfile warning: ignoring unsupported tag `EXTRA_SEARCH_MAPPINGS =' at line 1287, file doc/Doxyfile Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita bde066b9 2012-10-11T18:13:56 doc: use JAVADOC_AUTOBRIEF Don't have to type @brief all the time. Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita 108fa1c7 2012-09-22T15:02:54 Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>