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

qdoc doesn't document private signals (ie those using QPrivateSignal as parameter)

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P1: Critical
    • Resolution: Duplicate
    • Affects Version/s: 6.0.0 Alpha
    • Fix Version/s: None
    • Component/s: Build tools: qdoc
    • Labels:
      None
    • Platform/s:
      All

      Description

      Building qdoc from qttools:5b11b631914ff399d72f0a9b58a7b06e96fc7a6a and qtbase:1e2325f0dc39df3c91b7d74c7837961a0e12884e, and running it on qtbase generates a ton of warnings, such as

      error: out-of-line definition of 'rowsInserted' does not match any declaration in 'QAbstractItemModel'
      /Users/vohi/qt/dev/qtbase/src/corelib/itemmodels/qabstractitemmodel.cpp:1818: (qdoc) warning: clang found diagnostics parsing \fn void QAbstractItemModel::rowsAboutToBeInserted(const QModelIndex &parent, int start, int end)
      error: out-of-line definition of 'rowsAboutToBeInserted' does not match any declaration in 'QAbstractItemModel'
      /Users/vohi/qt/dev/qtbase/src/corelib/itemmodels/qabstractitemmodel.cpp:1832: (qdoc) warning: clang found diagnostics parsing \fn void QAbstractItemModel::rowsRemoved(const QModelIndex &parent, int first, int last)
      error: out-of-line definition of 'rowsRemoved' does not match any declaration in 'QAbstractItemModel'
      

      This warning is generated for all signals that use the QPrivateSignal type as a parameter, and those signals are then not documented in the resulting HTML file, and in addition generate many errors when qdoc cannot link documentation to them.

        Attachments

          Issue Links

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

            Activity

              People

              Assignee:
              treinio Topi Reiniƶ
              Reporter:
              vhilshei Volker Hilsheimer
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Gerrit Reviews

                  There are no open Gerrit changes