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

qdoc fails to document private signals

    XMLWordPrintable

Details

    • 7bb14bc39 (dev), 3c86f4219 (6.9)
    • DaVinci 112

    Description

      Consider the following code:

      #include <QObject>

/*!
 * \class Foo
 *
 * Yo
 */
class Foo : public QObject
{
    Q_OBJECT
Q_SIGNALS:
    /*!
     * A signal
     */
    void stuff(QPrivateSignal);
    /*!
     * Another signal
     */
    void more();
};

      The generated HTML shows only the 'more' signal, but not the 'stuff' signal.

      The build log has

      /home/nico/workspace/privatesignal/foo.h:13: (qdoc) warning: Cannot tie this documentation to anything

    [qdoc found a /*! ... */ comment, but there was no topic command (e.g., '\fn', '\page') in the comment and no function definition following the comment.]

      Removing the QPrivateSignal arg makes the signal show up in the documentation.

      qttools commit 942ddc8f17436014539342d2d33c9095dbb9900f

      Attachments

        For Gerrit Dashboard: QTBUG-132881
        # Subject Branch Project Status CR V
        621280,3 qdoc: Fix auto-tying private signal documentation in headers dev qt/qttools Status: MERGED +2 0
        621410,2 qdoc: Fix auto-tying private signal documentation in headers 6.9 qt/qttools Status: MERGED +2 0

        Activity

          People

            treinio Topi Reiniö
            nicolasfella Nicolas Fella
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes