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

Linking to a specific QML function signature doesn't work

    XMLWordPrintable

Details

    • Bug
    • Resolution: Unresolved
    • P2: Important
    • None
    • 6.7
    • Build tools: qdoc
    • None

    Description

      In https://codereview.qt-project.org/c/qt/qtdeclarative/+/487191/3, I've noticed that the following usage of \link doesn't result in a link being generated:

      To push several items onto the stack, use \l replaceCurrentItem(items, operation).
      

      There are no errors related to this in the build output.

      https://doc.qt.io/qt-6/08-qdoc-commands-creatinglinks.html#l-link says:

      For the one-parameter version, the braces can often be omitted. The \l command supports several ways of linking:

      • \l QWidget - The name of a class documented with the \class command.
      • \l QWidget::sizeHint() - The signature of a function without parameters. If a matching function without parameters can't be found, the link is satisfied with the first matching function found.
      • \l QWidget::removeAction(QAction* action) - The signature of a function with parameters. If an exact match is not found, the link is not satisfied and QDoc reports a Can't link to... error.
        [...]

      Attachments

        Issue Links

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

          Activity

            People

              docinfrastructure Documentation Infrastructure Team
              mitch_curtis Mitch Curtis
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes