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
OPTIONS
---stdin, -i
Read the filenames to process from standard input. Ignored if
filenames are specified at the command line.
---format <string>, -f <string>
Generate output in the specific format. This can be used many times to
generate documentation in multiple formats. The default format is ``html''.
See the OUTPUT FORMAT OPTIONS section for a list of available formats.
---outputdir <path>, -d <path>
Write output in the specified path.
---url <url>, -u <url>
The URL which will be used for links when cross-referencing with this library.
---name <string>, -n <string>
Set the name of the library being processed, eg ``kdecore''
If no name is set, no index file is produced.
---xref <library>, -l <library>
Cross-reference with the specified library. This will allow referencing
of classes etc that exist in the linked library. This option can be
specified multiple times.
For linking to work, you need to have generated documentation for the
linked library with kdoc, so that the necessary index file is produced.
---libdir <path>, -L <path>
Set the directory that will be used to store the index files generated
for cross-referencing. This is also used to search for index files for
xref. The default is $HOME/.kdoc.
If multiple paths are specified, each will be searched in order of
specification on the command line.
Unless --liboutdir is specified (see below), the generated .kdoc file will
be written to the first path specified with this option.
---liboutdir <path>
Set the directory where newly created xref libraries (see above) will be
written. The default is the libdir.
---compress, -z
Compress generated KDOC index files with gzip to save space.
---private, -p
Document all private members. These are not documented by default.
---skip-internal, -i
Do not document internal members. They are documented as internal by default.
---skip-deprecated, -e
Do not document deprecated members. They are documented as deprecated by
default.
---strip-h-path
Strip the path from the filenames in the output.
PREPROCESSOR OPTIONS
---cpp, -P
Pass each source file through the C preprocessor. Currently g++
is required for this, but this requirement will change before
2.0. Directories for inclusion in the preprocessor header search path
can be specified via the -I option.
---docincluded
Parse files that are included by the preprocessor #include macro.
This is off by default.
-cppcmd <command>, -C <command>
Specify the preprocessor command that will be used. The default is:
g++ -Wp,-C -E
All specified -I paths will be appended to the command. This option
quietly enables the -P option.
---includedir <path>, -I <path>
Add a directory to the preprocessor's header search paths. Requires the
-P option. This option can be specified multiple times.
OUTPUT FORMAT OPTIONS
html
Output documentation in HTML format. This is the default.
latex
Output documentation as a LaTeX document.
man
Output documentation as man pages.
texinfo
Output documentation in texinfo format. You must set the library name
with the -n option for the output to be generated.
docbook
Output documentation in the DocBook SGML format. You must set the library
name with the -n option for the output to be generated.
check
Print a report about the documentation, eg undocumented classes
and functions.
Output format modifiers
---html-css <url>
In HTML format, the stylesheet specified by this option will be used by
the generated documentation.
---html-cols <1, 2 ..>
In HTML format, set the number of columns for the Class Index.
---html-logo <image url>
In HTML format, specify the logo image to display on every page.
It will appear to the left of the quick links.
CROSS-REFERENCING LIBRARIES
FILES
*.kdoc, *.kdoc.gz
These are files that contain information about a library that has been
processed with kdoc. It is read for cross-referencing with other libraries
when the -l option is used.
The .gz extension signifies gzipped cross-reference files. kdoc is
capable of reading these, and generates them when the -z option is used.
ENVIRONMENT
KDOCLIBS
If this is set, it is used as the default for the directory where generated
cross-reference index files are saved. See also the ---libdir option.
SEE ALSO
See the qt2kdoc manpage for info on linking with the Qt docs, and the makekdedoc manpage for
info on generating documentation for the KDE libraries.
BUGS
Lots and Lots. Please send reports to the address kdoc@kde.org.
