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

Documentation for QScrollBar can be improved

XMLWordPrintable

    • All
    • d6abddcfc (dev), 4479c9ab6 (6.10), 0f317da26 (6.9)

      This is the tiniest of documentation bugs. Normally, I would directly submit a patch via pull request, but I am not exactly sure how to update the docs correctly.

      Official docs here: https://doc.qt.io/qt-5/qscrollbar.html

      In the introduction, the QAbstractSlider method tracking() is not correctly linked.
      Text:

      valueChanged() is emitted when the scroll bar's value has changed. The tracking() determines whether this signal is emitted during user interaction.
      

      Source code: qscrollbar.cpp
      This doc...

          \li \l{QAbstractSlider::valueChanged()}{valueChanged()} is emitted when the
             scroll bar's value has changed. The tracking() determines whether this
             signal is emitted during user interaction.
      

      Might be improved with:

          \li \l{QAbstractSlider::valueChanged()}{valueChanged()} is emitted when the
             scroll bar's value has changed. The \l{QAbstractSlider::hasTracking()}{hasTracking()} determines whether this
             signal is emitted during user interaction.
      

      ... but I am not exactly sure how to best create the link. Above is only a guess.

      tracking property docs can be found here: https://doc.qt.io/qt-5/qabstractslider.html#tracking-prop

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

            dheerendra Dheerendra Purohit
            kevinarpe@gmail.com Kevin Connor ARPE
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes