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

QT_NO_SIGNALS_SLOTS_KEYWORDS/QT_NO_KEYWORDS are undocumented

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Open
    • Priority: P3: Somewhat important
    • Resolution: Unresolved
    • Affects Version/s: 5.11.1
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      Both defines QT_NO_SIGNALS_SLOTS_KEYWORDS & QT_NO_KEYWORDS are in use out there in Qt-based software projects. Yet they are not mentioned anywhere in the Qt documentation (by what I saw and my search skills gave me).

      The only semi-official mention of the presence of those definitions I found is
      https://www.kdab.com/kdab-contributions-to-qt-5-0-part-5/

      The only related info I could find in the Qt documentation itself is about the flag to use with qmake (CONFIG += no_keywords), http://doc.qt.io/qt-5/signalsandslots.html#using-qt-with-3rd-party-signals-and-slots . Which misses a variant for the no-signals-slots-only case.
      And there is mention of the same qmake flag with the docs for the macros Q_SIGNALS, Q_SLOT, Q_SLOTS (http://doc.qt.io/qt-5/qobject.html#Q_SIGNALS ff.).

      To be able to reason about the use of those definitions in own code, to fellow developers or managers or students, it would be good to have some official statement in the Qt documentation (e.g. on the page http://doc.qt.io/qt-5/signalsandslots.html or with the QObject signal/slot macros).

      Or get an official statement here saying that those defines are unsupported and should be expected to disappear or change their behaviour any time in future versions (which would be sad, but one would be prepared ).

        Attachments

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

          Activity

            People

            Assignee:
            docteam Qt Documentation Team
            Reporter:
            kossebau Friedrich W. H. Kossebau
            Votes:
            4 Vote for this issue
            Watchers:
            5 Start watching this issue

              Dates

              Created:
              Updated:

                Gerrit Reviews

                There are no open Gerrit changes