Development/Tools/apidox

< Development‎ | Tools
Revision as of 13:56, 5 July 2008 by Winterz (Talk | contribs) (add info on how to build man pages for Qt)

Jump to: navigation, search

Intro

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

Please see our documentation policy and tutorial.

Generating

HTML pages

Generate apidox in html using kdedoxygen.sh: % cd source_dir % /path/to/trunk/KDE/kdesdk/scripts/kdedoxygen.sh

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 kdedoxyman.sh Like so: % cd source_dir % /path/to/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/to/kdeinstall/share

You can also generate man pages from Qt source code using kdedoxyman.sh: % cd qt-copy/src % /path/to/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/to/kdeinstall/share

and then add /path/to/kdeinstall/share/man to your $MANPATH environment variable.