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

[REG] qdoc in 5.6: linking fails for certain functions

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P2: Important
    • Resolution: Done
    • Affects Version/s: 5.6
    • Fix Version/s: 5.7.0 Alpha
    • Component/s: Build tools: qdoc
    • Labels:
      None
    • Commits:
      c3736856fb27a416a8d42a96fc8dcb27b2bf30a2

      Description

      QDoc in 5.6 has improved capability to create a link to the correct function overload based on the number/types of function parameters. However, I noticed that some links are now failing, they used to work on 5.5:

      /work/build/_qt5/qtdeclarative/examples/qml/doc/src/qml-extending.qdoc:65: warning: Can't link to 'qmlRegisterExtendedType()'
      /work/build/_qt5/qtdeclarative/src/qml/doc/src/cppintegration/definetypes.qdoc:27: warning: Can't link to 'qmlRegisterExtendedType()'
      /work/build/_qt5/qtbase/src/corelib/kernel/qmetatype.cpp:2080: warning: Can't link to 'qRegisterMetaTypeStreamOperators()'
      /work/build/_qt5/qtbase/src/corelib/kernel/qmimedata.cpp:552: warning: Can't link to 'qRegisterMetaTypeStreamOperators()'
      
      • Both of the above functions have an internal/undocumented variant (that takes no parameters) in the root namespace, and another, documented one (that takes parameters). Apparently QDoc finds the first one (as it matches the signature exactly) and gives up as it's internal. The expected result is a link to these functions:

      http://doc-snapshots.qt.io/qt5-5.6/qqmlengine.html#qmlRegisterExtendedType

      http://doc-snapshots.qt.io/qt5-5.6/qmetatype.html#qRegisterMetaTypeStreamOperators

        Attachments

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

          Activity

            People

            Assignee:
            gbk Martin Smith (Qt)
            Reporter:
            treinio Topi Reiniƶ
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Gerrit Reviews

                There are no open Gerrit changes