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

qdoc: Warn about self-link in \sa

    XMLWordPrintable

Details

    • Bug
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • 6.9.1
    • Build tools: qdoc
    • DaVinci 120, DaVinci 121

    Description

      qdoc warns about invalid links in \sa. Anyhow, if an entity references itself, it does not warn. It would be nice if it did.

      Example

      QQuickTableView::rowHeightProvider does link to itself in \sa:

      /*!
          \qmlproperty var QtQuick::TableView::rowHeightProvider
      
          This property can hold a function that returns the row height for each row
          in the model. It is called whenever TableView needs to know the height of
          a specific row. The function takes one argument, \c row, for which the
          TableView needs to know the height.
      
          [..]
          \sa rowHeightProvider, isRowLoaded(), {Row heights and column widths}
      */
      

      Anyhow, qdoc does not warn about this. Instead, it just prints the text without linkifying it:

      Attachments

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

        Activity

          People

            david.boddie David Boddie
            kkohne Kai Köhne
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There is 1 open Gerrit change