qdoc.exe

qdoc.exe

Usage: qdoc [options] file1.qdocconf ...
# Qt文档生成器
Qt documentation generator

# 设置
Options:
# 显示此帮助。
  -?, -h, --help                        Displays this help.
# 显示版本信息。
  -v, --version                         Displays version information.
# 在解析源代码时将参数定义为宏
  -D <macro[=def]>                      Define the argument as a macro while
                                        parsing sources
# 指定相关模块
  --depends <module>                    Specify dependent modules
# 打开语法突出显示（使用 qdoc 编译运行比较慢）
  --highlighting                        Turn on syntax highlighting (makes qdoc
                                        run slower)
# 包含内部标记的内容
  --showinternal                        Include content marked internal
# 将所有文档内容保存到 /dev/null。 如果有人只对qdoc错误感兴趣，这很有用。
  --redirect-documentation-to-dev-null  Save all documentation content to
                                        /dev/null. Useful if someone is
                                        interested in qdoc errors only.
# 不要为示例生成文档
  --no-examples                         Do not generate documentation for
                                        examples
# 指定QDoc应该搜索要加载的索引文件的目录
  --indexdir <dir>                      Specify a directory where QDoc should
                                        search for index files to load
# 在运行“make install”之后指定输出的目录
  --installdir <dir>                    Specify the directory where the output
                                        will be after running "make install"
# 报告从过时项目到非过时项目的链接
  --obsoletelinks                       Report links from obsolete items to
                                        non-obsolete items
# 指定输出目录，覆盖qdocconf文件中的设置
  --outputdir <dir>                     Specify output directory, overrides
                                        setting in qdocconf file
# 指定输出格式，覆盖qdocconf文件中的设置
  --outputformat <format>               Specify output format, overrides
                                        setting in qdocconf file
# 不要打印链接错误（即缺少目标）
  --no-link-errors                      Do not print link errors (i.e. missing
                                        targets)
# 自动链接失败时显示错误
  --autolink-errors                     Show errors when automatic linking
                                        fails
# 启用调试输出
  --debug                               Enable debug output
# 只运行qdoc来生成索引文件，而不是文档
  --prepare                             Run qdoc only to generate an index
                                        file, not the docs
# 运行qdoc来读取索引文件并生成文档
  --generate                            Run qdoc to read the index files and
                                        generate the docs
# 在stderr上记录进度。
  --log-progress                        Log progress on stderr.
# 在所有的qdoc conf文件中运行一次qdoc。
  --single-exec                         Run qdoc once over all the qdoc conf
                                        files.
# 编写QA页面。
  --write-qa-pages                      Write QA pages.

# 参数
Arguments:
  file1.qdocconf ...                    Input files