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

QDoc: Add support for methods in QML basic types

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Done
    • P2: Important
    • None
    • 5.2.0
    • Documentation
    • None
    • DaVinci sprint 3

    Description

      This page uses headers and inline code to emulate C++ method documentation: http://qt-project.org/doc/qt-5/qml-geoshape.html

          \section2 Methods
          \section3 contains()
          \code
          bool contains(coordinate coord)
          \endcode
      
          Returns true if...
      

      This page uses a table to list its methods: http://qt-project.org/doc/qt-5/qml-vector2d.html

      Both are human-readable, but they are presented inconsistently and the individual methods are cannot be linked to using normal function notation.

      e.g. Within the GeoShape page, this fails to link:

      \l{contains()}

      ...while this works:

      \l{contains}{contains()}

      Attachments

        For Gerrit Dashboard: QTBUG-36585
        # Subject Branch Project Status CR V

        Activity

          People

            treinio Topi Reiniƶ
            jksh Sze Howe Koh
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes