1

我想用 QDoc 生成文档，并按照 QDoc 指南的说明进行了尝试。我可以获得文档，但它并不完整。

我都试过了：

  • qt 5.11.3，llvm 6.0.1，Windows 10
  • qt 5.12.3、llvm 6.0.1、ubuntu 16.04

但都是一样的。

这是代码：

项目.qconconf

headerdirs  = .
sourcedirs  = .
exampledirs = .
imagedirs   = ./images

sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml"
examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"

outputdir   = html
outputformats = HTML

主窗口.cpp

/*!
 * \class MainWindow
 * \brief mainwindow for ui .
 */

/*!
  constructor
 */
MainWindow::MainWindow(QWidget *parent) :
    QMainWindow(parent),
    ui(new Ui::MainWindow)
{
    ui->setupUi(this);
}

/*!
  destructor
 */
MainWindow::~MainWindow()
{
    delete ui;
}

/*!
  function test
 */
bool MainWindow::test() const
{
    return test_;
}

/*!
  function setTest
 */
void MainWindow::setTest(bool test)
{
    test_ = test;
}

在我执行命令“qdoc proect.qdocconf”后，警告如下：

.../mainwindow.cpp:4: (qdoc) 警告：MainWindow 类没有 \inmodule 命令；默认使用项目名称：
.../mainwindow.cpp:9: (qdoc) 警告：无法将此文档绑定到任何内容 [我找到了 /*！... */ 评论，但评论中没有主题命令（例如，'\fn'，'\page'），并且评论后没有函数定义。]

我有两个文件：“.index”和“mainwindow.html”

“主窗口.html”：

MainWindow
内容
详细说明
MainWindow 类
主窗口，用于ui 界面。

更多的...

详细说明
ui 界面的主窗口。

似乎它无法获取除“\class”之外的任何其他信息。

有谁知道什么可能导致无法生成文档？

4

0 回答 0