NAME 

KDOC -- Programmers' Documentation Extraction and Generation Tool

SYNOPSIS 

        kdoc [-DqpieaP] [-f format] [-n libname] [-d outdir] [-u url] [-l lib]

        kdoc [--help]

        kdoc [--version]

DESCRIPTION 

KDOC uses specially formatted comments in your C++ headers and CORBA IDL files to create cross-referenced documentation in various formats.

KDOC can also correctly handle ``signal'' and ``slot'' specifiers as used by the Qt GUI Toolkit.

EXAMPLES 

        kdoc -f html -d /home/web/komdoc -n kom *.idl
        kdoc -d /home/web/kdecore
                -u "http://www.mydomain/kdecore/"
                -n kdecore ~/kdelibs/kdecore/*.h -lqt