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

qtdoc properties hide NOTIFY signal documentation

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • P2: Important
    • 5.6.0 RC
    • 5.5.1
    • Documentation
    • None
    • 23ed72b780dd510dd57a93b853232714fcd9f82c

    Description

      The QDnsLookup::errorString property NOTIFY signal is finished(). This makes sense.

      QDnsLookup::error property NOTIFY signal is finished(). This also makes sense.

      However, qtdoc assumes a one-to-one mapping of Q_PROPERTY to NOTIFY signal. The link to the finished() signal in the error property is a link to the errorString property. This does not make sense.

      http://doc.qt.io/qt-5/qdnslookup.html#errorString-prop

      Additionally, the detailed description links to the finished() signal but also takes the user to the property documentation. This also does not make sense.

      Additionally, the actual documentation of the finished() signal is not extracted to the generated documentation.

      http://code.woboq.org/qt5/qtbase/src/network/kernel/qdnslookup.cpp.html#231

      Attachments

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

        Activity

          People

            gbk Martin Smith (Qt)
            ske Steve
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes