Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-119727

Automatically generate QML documentation from C++

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • P2: Important
    • None
    • None
    • Build tools: qdoc
    • None

    Description

      If expose c++ to qml, at hte moment to document the qml types we need to duplicate the documentation, mostly. 

      It would be great if qdoc could do that automatically, if asked to. 

      The Qt for multimedia module documentation implementation really, highlighted this need. 

      Attachments

        Issue Links

          clones

          Suggestion - Public suggestions QTBUG-92450 Automatically generate QML enum documentation from C++

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          relates to

          User Story - Created by Jira Software - do not edit or delete. Issue type for a user story. QTBUG-131243 qdoc: Warn about usage of C++ types in QML API documentation

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Open
          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              docinfrastructure Documentation Infrastructure Team
              nick_bennett Nicholas Bennett
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes