(→HTML pages) |
(→HTML pages) |
||
| Line 19: | Line 19: | ||
* You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory. However, you can use the $HOME environment variable instead. | * You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory. However, you can use the $HOME environment variable instead. | ||
| − | * The QTDOCDIR environment variable | + | * The QTDOCDIR environment variable should point to the html folder of the Qt documentation. If QTDIR points to the Qt source directory, there is no need to set QTDOCDIR. |
To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}: | To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}: | ||
Contents |
The KDE project uses doxygen to generate API documentation from source code.
Please see our documentation policy and tutorial.
Generate apidox in the KDE format using
% cd html_dir
% /path/to/trunk/KDE/kdelibs/doc/api/doxygen.sh --recurse \
--doxdatadir=/path/to/trunk/KDE/kdelibs/doc/common \ /path/to/trunk/KDE/kdelibs
Notes:
To generate documentation in doxygen style instead of KDE style, use 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 page lovers can generate man pages using kdedoxyman.sh
Like so:
% cd source_dir
% /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share
You can also generate man pages from Qt source code using kdedoxyman.sh:
% cd qt-copy/src
% /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share
and then add /path/kdeinstall/share/man to your $MANPATH environment variable.
KDE TechBase 