(corrected link description) |
Neverendingo (Talk | contribs) m (Text replace - "</code>" to "</syntaxhighlight>") |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
The KDE project uses [http://www.doxygen.org doxygen] to generate API documentation from source code. | The KDE project uses [http://www.doxygen.org doxygen] to generate API documentation from source code. | ||
Line 8: | Line 7: | ||
===HTML pages=== | ===HTML pages=== | ||
Generate apidox in the KDE format using | Generate apidox in the KDE format using | ||
− | < | + | <syntaxhighlight lang="text"> |
% cd html_dir | % cd html_dir | ||
% /path/to/trunk/KDE/kdelibs/doc/api/doxygen.sh --recurse \ | % /path/to/trunk/KDE/kdelibs/doc/api/doxygen.sh --recurse \ | ||
--doxdatadir=/path/to/trunk/KDE/kdelibs/doc/common \ | --doxdatadir=/path/to/trunk/KDE/kdelibs/doc/common \ | ||
/path/to/trunk/KDE/kdelibs | /path/to/trunk/KDE/kdelibs | ||
− | </ | + | </syntaxhighlight> |
Notes: | Notes: | ||
Line 22: | Line 21: | ||
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}}: | ||
− | < | + | <syntaxhighlight lang="text"> |
% cd source_dir | % cd source_dir | ||
% /path/to/trunk/KDE/kdesdk/scripts/kdedoxygen.sh | % /path/to/trunk/KDE/kdesdk/scripts/kdedoxygen.sh | ||
− | </ | + | </syntaxhighlight> |
You'll find the top-level html at {{path|./apidocs/html/index.html}} | You'll find the top-level html at {{path|./apidocs/html/index.html}} | ||
Line 37: | Line 36: | ||
Man page lovers can generate man pages using {{program|kdedoxyman.sh}} | Man page lovers can generate man pages using {{program|kdedoxyman.sh}} | ||
Like so: | Like so: | ||
− | < | + | <syntaxhighlight lang="text"> |
% cd source_dir | % cd source_dir | ||
% /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share | % /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share | ||
− | </ | + | </syntaxhighlight> |
<br> | <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}}: | ||
− | < | + | <syntaxhighlight lang="text"> |
% cd qt-copy/src | % cd qt-copy/src | ||
% /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share | % /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share | ||
− | </ | + | </syntaxhighlight> |
<br> | <br> | ||
and then add {{path|/path/kdeinstall/share/man}} to your $MANPATH environment variable. | and then add {{path|/path/kdeinstall/share/man}} to your $MANPATH environment variable. |
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.
If you like to view API documentation with Qt's assistant, then you can generate the necessary 'qch' files using kdedoxyqt.sh.
Note that kdedoxyqt.sh requires doxygen as well as qhelpgenerator from the Qt toolkit.
To use:
% cd source_dir % /path/trunk/KDE/kdesdk/scripts/kdedoxyqt.sh [wait]
You should now have a file called apidocs/qch/KDE-4.2.qch in this current working directory. Copy KDE-4.2.qch some place for safe keeping.
Now, start assistant. Go into Edit->Preferences->Documentation and add the safe copy of KDE-4.2.qch into the db.