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

[docs] Add a \memberswap etc macros specially for RAII classes

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • P2: Important
    • None
    • None
    • Core: Other, Documentation, Other
    • None

    Description

      QSemaphoreReleaser has very nice documentation for it's swap() member¹ and move SMFs²³. This kind of documentation would also benefit other RAII classes, such as QMutexLocker and QSignalBlocker. So add RAII-specific macros to document them.

       

      ¹ https://doc.qt.io/qt-6/qsemaphorereleaser.html#swap

      ² https://doc.qt.io/qt-6/qsemaphorereleaser.html#QSemaphoreReleaser-1

      ³ https://doc.qt.io/qt-6/qsemaphorereleaser.html#operator-eq

       

      Attachments

        Issue Links

          is required for

          Task - A task that needs to be done. QTBUG-129789 Roll out \memberswap qdoc macro outside qtbase

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Open
          resulted from

          Task - A task that needs to be done. QTBUG-129573 Add a qdoc macro for the (member) swap() documentation blurb

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

          Activity

            People

              docteam Qt Documentation Team
              mmutz Marc Mutz
              Vladimir Minenko Vladimir Minenko
              Alex Blasche Alex Blasche
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes