QML/qdoc: Как определить оператор наследования и импорта

Question

Я сделал библиотеку qml и теперь хочу сделать документацию. Я использую QDoc с Qt 5.10.10 с msvc2015 и LLVM 9.0.0 .

Я хотел бы отобразить 2 следующих данных:

• наследование : я пробовал использовать \ наследование, но не вижу результата. Я попытался использовать элемент из QtQuick (с QtQuick :: Item) и элемент из моей собственной библиотеки. Я что-то пропустил ?
• Заявление об импорте : я просто не знаю, что делать. Кажется, мне нужно использовать \ qmlmodule, но у меня есть ошибка, использую ли я его в моем qdocconf или в моем файле qml.

Ниже кода, который у меня сейчас есть:

      // MyButton.qml - the header
    /*!
    QtQuick.Controls 1.1

    \qmltype SolidButton
    \qmlmodule MyModule
    \inherits QtQuick::Button
    \brief My button. It inherits from Button from QtQuick.

    \section1 Detailed Example

    \qml
    MyButton {
        text: "My Button";
    }
    \endqml
    */

// qdocconf

    sourcedirs += ../qml/
    headerdirs += ../qml/
    imagedirs = .

    sources.fileextensions = "*.qml"

    outputdir  =    ./doc/qml/
    outputformats = HTML

    HTML.stylesheets = style.css
    HTML.headerstyles = "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/style.css\"/>\n"

Answer 1

\qmlmodule не допускается в файле qml. Вы должны добавить его в отдельный файл myQMLmoduleName.qdoc:

       /*!
  \qmlmodule MyControls
  \brief Mycustom controls.
*/

затем добавьте расширения * .qdoc в myConfig.qdocconf для qdoc, чтобы найти myQMLmoduleName.qdoc.

      # what kind of sources should be processed
sources.fileextensions += "*.qdoc *.cpp *.qml"
sourcedirs += ../path/to/your/config/