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

Documentation review

    XMLWordPrintable

    Details

      Description

      General

      ApplicationWindow

      BusyIndicator

      Button

      CheckBox

      CheckDelegate

      ComboBox

      Control

      Container

      • Detailed description
        • "Typically the content items are statically declared as children of the container, but Container also provides an API to \l add, \l insert, \l move and \l remove items dynamically." https://codereview.qt-project.org/#/c/171341/

      Dial

      Drawer

      Frame

      GroupBox

      ItemDelegate

      • Detailed description
        • Could be helpful mention something that basically the whole API is inherited from AbstractButton. Mitch: this is already mentioned there.
      • ItemDelegate::highlighted
        • The mention of the default value seems out of place. Move it before the snippet and the explanation?

      Label

      Material

      Menu

      MenuItem

      Page

      PageIndicator

      Pane

      Popup

      ProgressBar

      RadioButton

      RadioDelegate

      RangeSlider

      • Detailed description
        • Add another, a bit more complex example snippet. For example, a slider from 1 to 100, first handle at 25, second handle at 75, and explain the values of position and visual position in LTR & RTL https://codereview.qt-project.org/#/c/173777/
      • RangeSlider::snapMode
      • RangeSlider::first/second.increase(), decrease()
        • Is it 0.1 or 10% of the whole range? 0.1, as documented.

      RoundButton (5.8 only)

      ScrollBar

      ScrollIndicator

      Slider

      SpinBox

      StackView

      SwipeDelegate

      SwipeView

      • Detailed description
      • Attached properties
        • What are they really used for? done in 5.8
        • Example snippets! done in 5.8

      Switch

      SwitchDelegate

      TabBar

      • Brief description
      • Detailed description
        • Add a GIF to make it easier to get an understanding at a glimpse (ignored, animation hard to follow without some extensive content. there are several screenshots already)
        • "Typically the content items are statically declared as children of the container, but the base type \l Container also provides an API to \l add, \l insert, \l move and \l remove items dynamically." https://codereview.qt-project.org/#/c/175196/
      • TabBar::position

      TabButton

      TextArea

      TextField

      ToolBar

      ToolButton

      ToolTip

      Tumbler

      Universal

        Attachments

          Issue Links

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

            Activity

              People

              Assignee:
              mitch_curtis Mitch Curtis
              Reporter:
              jpnurmi J-P Nurmi
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Gerrit Reviews

                  There are no open Gerrit changes