< Development‎ | Tools
Revision as of 14:19, 12 August 2008 by Djarvie (talk | contribs) (HTML pages: How to generate HTML apidox in KDE format)
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 the KDE format using % cd html_dir % /path/to/trunk/KDE/kdelibs/doc/api/ --recurse \

   --doxdatadir=/path/to/trunk/KDE/kdelibs/doc/common \


  • You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory.
  • QTDIR environment variable must first be set to point to the Qt installation directory.

To generate documentation in doxygen style instead of KDE style, use % 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.