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

Emphasize "attached" signals and properties in the body of API description

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • None
    • Build tools: qdoc
    • None

    Description

      This as an example:

      https://doc.qt.io/qt-6/qml-qtquick-tableview.html#pooled-signal

      The title and the description of the function, does not say anything about being an "attached" property. It's under "attached signals" section but it's confusing. Luckily, there are some code snippets in the same documentation about how to use this "attached" signal.

      The suggestion is to search whole API documentation for attached signals and properties and make sure that there is a sign in descriptions or on the title to emphasize being an "attached" property/signal.

       

       

      Attachments

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

        Activity

          People

            docinfrastructure Documentation Infrastructure Team
            soarmin Soheil Armin
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes