NAME
qt2kdoc -- Generates cross-reference file suitable for use with KDOC from Qt Toolkit HTML documentation.
SYNOPSIS
qt2kdoc [-u URL] [-o <destdir>] [-z] <path to qt html>
DESCRIPTION
qt2kdoc generates a kdoc(1) cross-reference file from the classes.html file that is included with the Qt GUI Toolkit HTML documentation.
The resulting file can be used to cross-reference documentation generated with KDOC for other classes with the Qt HTML documentation.
OPTIONS
- --url <url>, -u <url>
-
The URL by which the Qt documentation can be accessed. This will allow other libraries to link to the Qt documentation.
- --outdir <path>, -o <path>
-
The directory where the generated index file will be written.
- --compress, -z
-
Compress the generated index with gzip. KDOC can read these compressed index files.
EXAMPLES
qt2kdoc -u "http://www.mydomain/src/qthtml/" \$HOME/web/src/qthtml
ENVIRONMENT
- KDOCLIBS
-
If set, it is used as the default output path. It is overridden by the --outdir option.
FILES
- classes.html, functions.html
-
The files from which information about the Qt library is read. They are parsed by qt2kdoc.
- qt.kdoc
-
A kdoc(1) cross-reference file that will be generated by qt2kdoc and can be used to link documentation generated by kdoc with the Qt documentation.
SEE ALSO
This script is a utility for kdoc(1).
BUGS
Dependent on format of Qt documentation.
AUTHOR
Sirtaj S. Kang <[email protected]>, 1998.