Development/Tools/apidox: Difference between revisions

    From KDE TechBase
    (initial version)
     
    (add info on how to build man pages for Qt)
    Line 25: Line 25:
    <code>
    <code>
    % cd source_dir
    % cd source_dir
    % /path/to/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/to/kdeinstall/share
    </code>
    You can also generate man pages from Qt source code using {{program|kdedoxyman.sh}}:
    <code>
    % cd qt-copy/src
    % /path/to/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/to/kdeinstall/share
    % /path/to/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/to/kdeinstall/share
    </code>
    </code>


    and then add {{path|/path/to/kdeinstall/share/man}} to your $MANPATH environment variable.
    and then add {{path|/path/to/kdeinstall/share/man}} to your $MANPATH environment variable.

    Revision as of 13:56, 5 July 2008

    Intro

    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 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 pages

    Man page lovers can generate man pages using kdedoxyman.sh Like so: % cd source_dir % /path/to/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/to/kdeinstall/share

    You can also generate man pages from Qt source code using kdedoxyman.sh: % cd qt-copy/src % /path/to/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/to/kdeinstall/share

    and then add /path/to/kdeinstall/share/man to your $MANPATH environment variable.