Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-14988 Documentation Tool chain
  3. QTBUG-7138

QDoc needs to be able to document exposed JS functions

    XMLWordPrintable

Details

    • Sub-task
    • Resolution: Out of scope
    • P2: Important
    • 4.8.x
    • Documentation
    • None

    Description

      The QtDeclarative module exposes some JS functions through the global object for use within QML. QDoc currently does not document these at all. What would be needed is someway for QDoc to generate formatted and aggregated docs for the JS functions exported by a module to the JS global object, where the documentation of the JS functions is next to the C++ functions that they are bound to.

      As modules other than QtDeclarative may expose their own JS objects and functions into QML in the future, it would be preferable that the solution not be specific to the Declarative module.

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            gbk Martin Smith (Qt)
            aalpert-nokia Alan Alpert (closed Nokia identity) (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes