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

qdoc: Warn about self-link in \sa

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: P3: Somewhat important P3: Somewhat important
    • None
    • 6.9.1
    • Build tools: qdoc
    • 009de365c (dev), bb30dc9f0 (dev), 253dadeb7 (dev), a0d6e496e (dev), 242e6a21b (6.10), 612947e86 (6.10), 24a120929 (6.10), 79e4e1f75 (dev)
    • DaVinci 120, DaVinci 121, DaVinci 122, DaVinci 123, DaVinci 124, DaVinci 125, DaVinci 126, DaVinci 127

      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:

        For Gerrit Dashboard: QTBUG-137048
        # Subject Branch Project Status CR V

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

              Created:
              Updated:

                There is 1 open Gerrit change