GNU/Linux man pages
Livre :
Expressions régulières,
Syntaxe et mise en oeuvre :
GNU/Linux |
RedHat 6.2(Zoot) |
|
 |
kdoc(1) |
 |
KDOC -- Programmers’ Documentation Extraction and Generation Tool
kdoc [-HMTDqpiea] [-n libname] [-d outdir] [-u url] [-l lib]
kdoc [-H] [--help]
kdoc [-v] [--version]
KDOC uses specially formatted comments in your C ++ headers and CORBA IDL files to create cross-referenced documentation. Current output formats are HTML and LaTeX.
KDOC can also correctly handle "signal" and "slot" specifiers as used by the Qt GUI Toolkit.
kdoc --html -d /home/web/komdoc -n kom *.idl
kdoc -d /home/web/kdecore
-u "http://www.mydomain/kdecore/"
-n kdecore ~/kdelibs/kdecore/*.h -lqt
--outputdir <path>, −d <path>
Write output in the specified path.
--url, −u
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.
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.
--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.
--html, −H
Output documentation in HTML format.
--latex, −T
Output documentation as a LaTeX document.
--man, −M
Output documentation as man pages.
--texinfo, −X
Output documentation in texinfo format.
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 the qt2kdoc manpage for info on linking with the Qt docs, and the makekdedoc manpage for info on generating documentation for the KDE libraries.
Lots and Lots. Please send reports to the address below.
Sirtaj Singh Kang <taj@kde.org>. kdoc has a web page at: http://www.ph.unimelb.edu.au/~ssk/kde/kdoc
|
kdoc(1) | |