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

Properly document "private" signals

    XMLWordPrintable

    Details

    • Commits:
      aea74dcaee2d6930e4d69cbda83088703b45816e, 92ea91836eedcf34e09df6b2bd3c34f0468acc49

      Description

      Some signals have a QPrivateSignal argument that forbids their emission from outside the class.

      Such an argument is currently ignored by qdoc by means of #ifdef macros. Instead I think that qdoc should recognize it and add a note in the documentation that the signal is not supposed to be emitted directly by the user.

        Attachments

          Issue Links

          is required for

          Task - A task that needs to be done. QTBUG-43865 Qt 5.5 Documentation Issues [meta]

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          For Gerrit Dashboard: QTBUG-45535
          # Subject Branch Project Status CR V
          110352,5 qdoc: Properly document "private" signals 5.5 qt/qtbase Status: MERGED +2 0
          110666,2 qdoc: Remove #ifdef Q_QDOC for uses of QPrivateSignal 5.5 qt/qtbase Status: MERGED +2 0

            Activity

              People

              Assignee:
              gbk Martin Smith (Qt)
              Reporter:
              peppe Giuseppe D'Angelo
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Gerrit Reviews

                  There are no open Gerrit changes