Important: Please read the Qt Code of Conduct - https://forum.qt.io/topic/113070/qt-code-of-conduct

Documenting QML



  • I have a question about QML documentation. If I use the \brief tag then the following sentence will be documented right, something like this:

    /*!
      \brief GuidanceBarSettingsScreen.qml Is a 'Console' settings Screen.
    */
    

    but what if I want a longer description to follow that? Can I just add it to the next line like so:

    /*!
      \brief GuidanceBarSettingsScreen.qml Is a 'Console' settings Screen.
      
      This screen is part of the 'Console' settings and allows the user
      to enabled/disable certain guidance settings from within the
      settings window.
    */
    

    Also, I know I can reference groups using the \ingroup tag, but how can I reference other QMl files? Is there an equivalent QML docs tag for the Doxygen tag: @ref ?

    Also, what exactly is a QML class? Can any .qml technically be called a QML class? The only reason I ask is because here they differentiate a QML class from other QML items.



  • \class in that context is referring to C++ classes. That page is not specific to QDoc in just QML.

    It looks like from that page that \brief will capture a continuous set of text without an empty line in between.

    so:

    \brief blah blah blah
    blah blah blah
    blah blah blah
    
    nope nope nope nope
    nope nope nope nope
    nope nope nope nope
    

    This should keep the blah's in the brief and the nope's in the extended version, whenever that appears.

    Edit: But, class may be appropriate to use before the meat of the code in a QML file. Unless there is a QML specific tag for this.



  • \class in that context is referring to C++ classes. That page is not specific to QDoc in just QML.

    It looks like from that page that \brief will capture a continuous set of text without an empty line in between.

    so:

    \brief blah blah blah
    blah blah blah
    blah blah blah
    
    nope nope nope nope
    nope nope nope nope
    nope nope nope nope
    

    This should keep the blah's in the brief and the nope's in the extended version, whenever that appears.

    Edit: But, class may be appropriate to use before the meat of the code in a QML file. Unless there is a QML specific tag for this.


Log in to reply