问题标签 [qdoc]

目标

出于文档目的，我想将 QtCreator 中的 C++ 代码片段导出为 HTML 文件，然后使用 CSS 突出显示其语法，例如：

由于 QtCreator 没有导出选项，我正在使用QDoc它来实现。

根据文档，我\quotefile在qdoc项目中使用 -file 将源代码main.cpp转换为 HTML：

运行qdoc产生一个index.html，打开后确实有main.cpp.

注意：为了演示我使用文档中的代码的问题：

问题

当我在浏览器中检查生成的 html 代码时，hello(例如，我得到：

然而，当我检查文档的 html 代码时，我相信它也是在 的帮助下生成的QDoc，对于我看到的同一部分：

我不知道为什么在我的情况下缺少附加标记。

问题

如何设置 QDoc，以便我可以指定如何标记代码片段的每个部分的规则？

我制作了一个 qml 库，现在我想制作一个文档。我将 QDoc 与Qt 5.10.10 与 msvc2015和LLVM 9.0.0一起使用。

我想显示以下 2 个数据：

• 继承：我尝试使用 \inherits 但我没有看到任何结果。我尝试使用 QtQuick 中的项目（使用 QtQuick::Item）和我自己的库中的项目。我错过了什么吗？
• 进口声明：我只是不知道该怎么做。看来我必须使用 \qmlmodule 但无论我在我的 qdocconf 还是在我的 qml 文件中使用它都有一个错误。

在我目前拥有的代码下方：

----- 编辑：正如评论中所问的，这里是我的错误

• 继承：我只是没有看到任何结果。\inherits 对 qt 控件或我自己的本地控件没有影响
• 进口声明。如果我尝试在我的 qml 文件中使用 \qmlmodule，我会收到此错误 如果我什么都不做，我会收到以下信息：

----- 编辑 2：我还应该提到我使用的是 Visual Studio，而不是 Qt Creator

I am writing a qt like documentation and qDoc is ignoring classes in namespace. If I want to document class which is not on namespace I use:

When there is a namespace I use:

Anyway, Mynamespace::ClassName is not a part of final documentation, no html files are generated for that class. Documentation for classes with no namespaces works fine. Any idea what is wrong here? I am not getting any warning. Qt 5.4.1

即使我的问题与此类似，所提供的答案也不能解决我的问题。

我正在尝试生成我的第一个QDoc输出。为了测试它，现在我只有一条评论main.cpp：

这是我的配置文件：

问题 #1：在最小示例中，该project字段不存在。但没有它，运行qdoc myproject.qdocconf我得到：

问题 #2：project设置字段后，输出如下：

我不确定如何包含路径。在这里我找不到这样的include命令。它创建了输出docs目录，但它几乎是空的：只有myproject,index文件在那里。

我必须做些什么来生成 HTML 文件？