< Development‎ | Tools
Revision as of 13:59, 5 July 2008 by Winterz (Talk | contribs)

Jump to: navigation, search


The KDE project uses doxygen to generate API documentation from source code.

Please see our documentation policy and tutorial.


HTML pages

Generate apidox in html using % cd source_dir % /path/to/trunk/KDE/kdesdk/scripts/

You'll find the top-level html at ./apidocs/html/index.html Load that page into your favorite web browser, review your documentation, then edit your code accordingly.

Warnings from doxygen will be found in ./doxygen.log. Please try to fix all warnings reported by doxygen.

Man pages

Man page lovers can generate man pages using Like so: % cd source_dir % /path/trunk/KDE/kdesdk/scripts/ -d /path/kdeinstall/share
You can also generate man pages from Qt source code using % cd qt-copy/src % /path/trunk/KDE/kdesdk/scripts/ -d /path/kdeinstall/share
and then add /path/kdeinstall/share/man to your $MANPATH environment variable.

Content is available under Creative Commons License SA 4.0 unless otherwise noted.