Difference between revisions of "Development/Tools/apidox"

Jump to: navigation, search
(Remove ‘Intro heading)
m (Text replace - "<code>" to "<syntaxhighlight lang="text">")
Line 7: Line 7:
 
===HTML pages===
 
===HTML pages===
 
Generate apidox in the KDE format using
 
Generate apidox in the KDE format using
<code>
+
<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 \
Line 21: 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}}:
<code>
+
<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
Line 36: 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:
<code>
+
<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
Line 42: Line 42:
 
<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}}:
<code>
+
<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

Revision as of 21:44, 29 June 2011

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 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
</code>
 
Notes:
 
* 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 should point to the html folder of the Qt documentation.  If QTDOCDIR is not set, doxygen.sh will try to find the documentation based on the value of QTDIR.
 
To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}:
<syntaxhighlight lang="text">
% cd source_dir
% /path/to/trunk/KDE/kdesdk/scripts/kdedoxygen.sh
</code>
 
You'll find the top-level html at {{path|./apidocs/html/index.html}}
Load that page into your favorite web browser, review your documentation,
then edit your code accordingly.
 
Warnings from {{program|doxygen}} will be found in {{path|./doxygen.log}}.
Please try to fix all warnings reported by {{program|doxygen}}.
 
===Man pages===
Man page lovers can generate man pages using {{program|kdedoxyman.sh}}
Like so:
<syntaxhighlight lang="text">
% cd source_dir
% /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share
</code>
<br>
You can also generate man pages from Qt source code using {{program|kdedoxyman.sh}}:
<syntaxhighlight lang="text">
% cd qt-copy/src
% /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share
</code>
<br>
and then add {{path|/path/kdeinstall/share/man}} to your $MANPATH environment variable.
 
===Qt Assistant===
If you like to view API documentation with Qt's {{program|assistant}}, then you can generate the necessary 'qch' files using {{program|kdedoxyqt.sh}}.
 
Note that {{program|kdedoxyqt.sh}} requires {{program|doxygen}} as well as {{program|qhelpgenerator}} from the Qt toolkit.
 
{{warning|doxygen v1.5.7 or above is required.}}
 
To use:
<pre>
% cd source_dir
% /path/trunk/KDE/kdesdk/scripts/kdedoxyqt.sh
[wait]
</pre>
 
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 {{program|assistant}}.  Go into Edit->Preferences->Documentation
and add the safe copy of KDE-4.2.qch into the db.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal