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) предупреждение: невозможно связать эту документацию с чем-либо [я нашел /*! ... */ comment, но в комментарии не было команды темы (например, '\fn', '\page') и определения функции после комментария.]

Я получил два файла: ".index" и "mainwindow.html"

"Mainwindow.html":

MainWindow
содержание
Подробное описание
Класс MainWindow
Главное окно для интерфейса пользователя.

Больше...

Подробное описание
Главное окно для интерфейса пользователя.

Похоже, что он не может получить любую другую информацию, кроме "\class".

Кто-нибудь знает, что может привести к тому, что документация не будет сгенерирована?

0 ответов

Другие вопросы по тегам