QDoc可以生成文档,但内容不完整

时间:2019-04-24 02:14:52

标签: c++ qt qt5 qdoc

我想使用QDoc生成文档,并且按照QDoc指南的说明进行了尝试。我可以获取文档,但是还不完整。

我都尝试过:

  • qt 5.11.3,llvm 6.0.1,Windows 10
  • qt 5.12.3,llvm 6.0.1,ubuntu 16.04

但是都一样。

代码如下:

project.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

mainwindow.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”

“ mainwindow.html”:

  

MainWindow
  内容
  详细说明
  MainWindow类别
  ui界面的主窗口。

更多...

  

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

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

有人知道是什么原因导致无法生成文档吗?

0 个答案:

没有答案