(add info on how to build man pages for Qt) |
m |
||
| Line 25: | Line 25: | ||
<code> | <code> | ||
% cd source_dir | % cd source_dir | ||
| − | % /path | + | % /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share |
</code> | </code> | ||
| − | + | <br> | |
You can also generate man pages from Qt source code using {{program|kdedoxyman.sh}}: | You can also generate man pages from Qt source code using {{program|kdedoxyman.sh}}: | ||
<code> | <code> | ||
% cd qt-copy/src | % cd qt-copy/src | ||
| − | % /path | + | % /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share |
</code> | </code> | ||
| − | + | <br> | |
| − | and then add {{path|/path | + | and then add {{path|/path/kdeinstall/share/man}} to your $MANPATH environment variable. |
Contents |
The KDE project uses doxygen to generate API documentation from source code.
Please see our documentation policy and tutorial.
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 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 