Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Users
  • Groups
  • Search
  • Get Qt Extensions
  • Unsolved
Collapse
Brand Logo
  1. Home
  2. Qt Development
  3. Qt Creator and other tools
  4. \group and \ingroup topic command for QML documentation
Forum Updated to NodeBB v4.3 + New Features

\group and \ingroup topic command for QML documentation

Scheduled Pinned Locked Moved Qt Creator and other tools
4 Posts 2 Posters 1.9k Views 1 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • X Offline
    X Offline
    X-Krys
    wrote on last edited by
    #1

    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

    1 Reply Last reply
    0
    • X Offline
      X Offline
      X-Krys
      wrote on last edited by
      #2

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

      1 Reply Last reply
      0
      • Z Offline
        Z Offline
        Zarkon
        wrote on last edited by
        #3

        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.

        1 Reply Last reply
        0
        • Z Offline
          Z Offline
          Zarkon
          wrote on last edited by
          #4

          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.

          1 Reply Last reply
          0

          • Login

          • Login or register to search.
          • First post
            Last post
          0
          • Categories
          • Recent
          • Tags
          • Popular
          • Users
          • Groups
          • Search
          • Get Qt Extensions
          • Unsolved