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

Document macros in qtclasshelpermacros.h and qshareddata.h

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • P2: Important
    • None
    • None
    • Core: Other
    • Foundation PM Staging

    Description

      qtclasshelpermacros.h:

      This is a public header and some of the macros are documented here: https://doc.qt.io/qt-6/qtclasshelpermacros-qtcore-proxy.html

      Others are missing but have a comment in the source code, e.g. QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_MOVE_AND_SWAP and QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP.

      qshareddata.h:

      This is also a public header with public classes documented here: https://doc.qt.io/qt-6/qexplicitlyshareddatapointer.html, https://doc.qt.io/qt-6/qshareddatapointer.html, https://doc.qt.io/qt-6/qshareddata.html

      Macros, e.g. QT_DECLARE_QSDP_SPECIALIZATION_DTOR and QT_DECLARE_QSDP_SPECIALIZATION_DTOR_WITH_EXPORT are not documented. The only source for their purpose is https://wiki.qt.io/Things_To_Look_Out_For_In_Reviews.

      Maybe these should go to qtclasshelpermacros.h?

       

      Generally it would be good to have a best practice on what to use.

      Attachments

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

        Activity

          People

            cnn Qt Core & Network
            matthias_rauter Matthias Rauter
            Vladimir Minenko Vladimir Minenko
            Alex Blasche Alex Blasche
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes