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

\group and \ingroup topic command for QML documentation



  • I'm documenting my own library of QML components and I'm having somme issues with \group and \ingroup commands.

    I put this kind of comments in each of my components :

    @import QtQuick 1.1
    /*!
    \ingroup base-components
    \brief Provides ....
    */
    MyComponent {
    ....
    }
    @

    Then in a components.qdoc file I put :

    @/*!
    \group base-components
    \title Base Components

     This is a list of base components.
    
     \generatelist {related}
    

    */
    @

    After I've lauched qdoc the I've got one html file for each component with its doc but components.html doesn't generate the list of components....

    Here is the ouput of qdoc :

    @Building up file structure...
    Insert custom filters...
    Insert help data for filter section (1 of 1)...
    Insert files...
    Insert contents...
    Insert indices...
    Documentation successfully generated.@

    Any idea ?

    I'm using qdoc shipped with qt 4.8.1 libs



  • Nobody has issues with \generatelist {related} ???



  • I am facing the same kind of problems.

    \qmlmodule and \inqmlmodule also don't seem to work well. I don't want to use doxygen. Because our docs need to become integral part of the help.



  • I am facing the same kind of problems.

    \qmlmodule and \inqmlmodule also don't seem to work well. I don't want to use doxygen. Because our docs need to become integral part of the help.


Log in to reply