QDoc может генерировать документацию, но содержимое не заполнено - PullRequest
Новая
       12

QDoc может генерировать документацию, но содержимое не заполнено

1 голос
/ 24 апреля 2019

Я хочу сгенерировать документацию с помощью 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".

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

...