diff options
author | J-P Nurmi <jpnurmi@theqtcompany.com> | 2015-10-19 19:37:19 +0200 |
---|---|---|
committer | J-P Nurmi <jpnurmi@theqtcompany.com> | 2015-10-20 10:54:04 +0000 |
commit | af531e14b31da62347fe489562951fdf7f378208 (patch) | |
tree | e11f6d3c6d5a9b2e7a852f8ad8b426b4c4ae550b | |
parent | f03c4634604499b9d2ab193f678c850a2404c88b (diff) |
Docs: disambiguate group sections
Change-Id: Ia6e8a53b8b5261e1efd80dcd3351cd216d34edf4
Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
29 files changed, 97 insertions, 107 deletions
diff --git a/src/imports/controls/doc/src/qtlabscontrols-buttons.qdoc b/src/imports/controls/doc/src/qtlabscontrols-buttons.qdoc index 90c2718e..562b21c6 100644 --- a/src/imports/controls/doc/src/qtlabscontrols-buttons.qdoc +++ b/src/imports/controls/doc/src/qtlabscontrols-buttons.qdoc @@ -27,7 +27,7 @@ /*! \page qtlabscontrols-buttons.html - \title Buttons + \title Button Controls Qt Labs Controls offers a selection of button-like controls. @@ -37,43 +37,43 @@ sections offer guidelines for choosing the appropriate type of button, depending on the use case. - \section1 Button + \section1 Button Control \image qtlabscontrols-button.png - \l {Qt.labs.controls::Button}{Button} presents a push-button control - that can be pushed or clicked by the user. Buttons are normally used - to perform an action, or to answer a question. Typical buttons are - \e OK, \e Apply, \e Cancel, \e Close, \e Yes, \e No, and \e Help. + \l Button presents a push-button control that can be pushed or clicked + by the user. Buttons are normally used to perform an action, or to answer + a question. Typical buttons are \e OK, \e Apply, \e Cancel, \e Close, + \e Yes, \e No, and \e Help. - \section1 CheckBox + \section1 CheckBox Control \image qtlabscontrols-checkbox.png - \l {Qt.labs.controls::CheckBox}{CheckBox} presents an option button - that can be toggled on (checked) or off (unchecked). Check boxes are - typically used to select one or more options from a set of options. + \l CheckBox presents an option button that can be toggled on (checked) + or off (unchecked). Check boxes are typically used to select one or more + options from a set of options. - \section1 RadioButton + \section1 RadioButton Control \image qtlabscontrols-radiobutton.png - \l {Qt.labs.controls::RadioButton}{RadioButton} presents an option button - that can be toggled on (checked) or off (unchecked). Radio buttons are - typically used to select one option from a set of options. + \l RadioButton presents an option button that can be toggled on (checked) + or off (unchecked). Radio buttons are typically used to select one option + from a set of options. - \section1 Switch + \section1 Switch Control \image qtlabscontrols-switch.png - \l {Qt.labs.controls::Switch}{Switch} is an option button that can be - dragged or toggled on (checked) or off (unchecked). Switches are typically - used to select between two states. + \l Switch is an option button that can be dragged or toggled on (checked) + or off (unchecked). Switches are typically used to select between two + states. - \section1 ToolButton + \section1 ToolButton Control \image qtlabscontrols-toolbutton.png - \l {Qt.labs.controls::ToolButton}{ToolButton} is functionally similar to - \l Button, but provides a look that is more suitable within a \l ToolBar. + \l ToolButton is functionally similar to \l Button, but provides a look + that is more suitable within a \l ToolBar. */ diff --git a/src/imports/controls/doc/src/qtlabscontrols-containers.qdoc b/src/imports/controls/doc/src/qtlabscontrols-containers.qdoc index 30fa618f..cf47499c 100644 --- a/src/imports/controls/doc/src/qtlabscontrols-containers.qdoc +++ b/src/imports/controls/doc/src/qtlabscontrols-containers.qdoc @@ -27,7 +27,7 @@ /*! \page qtlabscontrols-containers.html - \title Containers + \title Container Controls Qt Labs Controls offers a selection of container-like controls. @@ -37,51 +37,48 @@ The following sections offer guidelines for choosing the appropriate type of container, depending on the use case. - \section1 ApplicationWindow + \section1 ApplicationWindow Control \image qtlabscontrols-applicationwindow-wireframe.png - \l {Qt.labs.controls::ApplicationWindow}{ApplicationWindow} contains - optional header and footer items. + \l ApplicationWindow contains optional header and footer items. - \section1 Frame + \section1 Frame Control \image qtlabscontrols-frame.png - \l {Qt.labs.controls::Frame}{Frame} is used to layout a logical group of - controls together, within a visual frame. + \l Frame is used to layout a logical group of controls together, within + a visual frame. - \section1 GroupBox + \section1 GroupBox Control \image qtlabscontrols-groupbox.png - \l {Qt.labs.controls::GroupBox}{GroupBox} is used to layout a logical - group of controls together, within a titled visual frame. + \l GroupBox is used to layout a logical group of controls together, + within a titled visual frame. - \section1 StackView + \section1 StackView Control \image qtlabscontrols-stackview-wireframe.png - \l {Qt.labs.controls::StackView}{StackView} organizes content pages into - a stack. + \l StackView organizes content pages into a stack. - \section1 SwipeView + \section1 SwipeView Control \image qtlabscontrols-swipeview-wireframe.png - \l {Qt.labs.controls::SwipeView}{SwipeView} organizes content pages into - a swipable strip. + \l SwipeView organizes content pages into a swipable strip. - \section1 TabBar + \section1 TabBar Control \image qtlabscontrols-tabbar-wireframe.png - \l {Qt.labs.controls::TabBar}{TabBar} organizes content pages into tabs. + \l TabBar organizes content pages into tabs. - \section1 ToolBar + \section1 ToolBar Control \image qtlabscontrols-toolbar.png - \l {Qt.labs.controls::ToolBar}{ToolBar} is a container of application-wide - and context-sensitive actions and controls. + \l ToolBar is a container of application-wide and context-sensitive + actions and controls. */ diff --git a/src/imports/controls/doc/src/qtlabscontrols-indicators.qdoc b/src/imports/controls/doc/src/qtlabscontrols-indicators.qdoc index 84b4dabc..11d440f7 100644 --- a/src/imports/controls/doc/src/qtlabscontrols-indicators.qdoc +++ b/src/imports/controls/doc/src/qtlabscontrols-indicators.qdoc @@ -27,7 +27,7 @@ /*! \page qtlabscontrols-indicators.html - \title Indicators + \title Indicator Controls Qt Labs Controls offers a selection of indicator-like controls. @@ -37,32 +37,31 @@ sections offer guidelines for choosing the appropriate type of indicator, depending on the use case. - \section1 BusyIndicator + \section1 BusyIndicator Control \image qtlabscontrols-busyindicator.png - \l {Qt.labs.controls::BusyIndicator}{BusyIndicator} should be used to - indicate activity. + \l BusyIndicator should be used to indicate activity. - \section1 PageIndicator + \section1 PageIndicator Control \image qtlabscontrols-pageindicator.png - \l {Qt.labs.controls::PageIndicator}{PageIndicator} is used to indicate - the currently active page in a container of multiple pages. + \l PageIndicator is used to indicate the currently active page in + a container of multiple pages. - \section1 ScrollBar + \section1 ScrollBar Control \image qtlabscontrols-scrollbar.png - \l {Qt.labs.controls::ScrollBar}{ScrollBar} is an interactive bar that - indicates the current scroll position, and can be used to scroll to a - specific position in a \l Flickable. + \l ScrollBar is an interactive bar that indicates the current scroll + position, and can be used to scroll to a specific position in a + \l Flickable. - \section1 ScrollIndicator + \section1 ScrollIndicator Control \image qtlabscontrols-scrollindicator.png - \l {Qt.labs.controls::ScrollIndicator}{ScrollIndicator} is a non-interactive - indicator that indicates the current scroll position in a \l Flickable. + \l ScrollIndicator is a non-interactive indicator that indicates the + current scroll position in a \l Flickable. */ diff --git a/src/imports/controls/doc/src/qtlabscontrols-input.qdoc b/src/imports/controls/doc/src/qtlabscontrols-input.qdoc index 3de8d5c6..130ca83d 100644 --- a/src/imports/controls/doc/src/qtlabscontrols-input.qdoc +++ b/src/imports/controls/doc/src/qtlabscontrols-input.qdoc @@ -27,7 +27,7 @@ /*! \page qtlabscontrols-input.html - \title Input + \title Input Controls Qt Labs Controls offers a variety of input controls for both numeric and textual input. @@ -38,43 +38,40 @@ following sections offer guidelines for choosing the appropriate type of input control, depending on the use case. - \section1 Dial + \section1 Dial Control \image qtlabscontrols-dial.png - \l {Qt.labs.controls::Dial}{Dial} is a circular dial that is rotated - to set a value. + \l Dial is a circular dial that is rotated to set a value. - \section1 TextArea + \section1 TextArea Control \image qtlabscontrols-textarea.png - \l {Qt.labs.controls::TextArea}{TextArea} is a multi-line text editor. + \l TextArea is a multi-line text editor. - \section1 TextField + \section1 TextField Control \image qtlabscontrols-textfield.png - \l {Qt.labs.controls::TextField}{TextField} is a single line text editor. + \l TextField is a single line text editor. - \section1 Slider + \section1 Slider Control \image qtlabscontrols-slider.png - \l {Qt.labs.controls::Slider}{Slider} is used to select a value by - sliding a handle along a track. + \l Slider is used to select a value by sliding a handle along a track. - \section1 RangeSlider + \section1 RangeSlider Control \image qtlabscontrols-rangeslider.png - \l {Qt.labs.controls::RangeSlider}{RangeSlider} is used to select a - range specified by two values, by sliding each handle along a track. + \l RangeSlider is used to select a range specified by two values, + by sliding each handle along a track. - \section1 Tumbler + \section1 Tumbler Control \image qtlabscontrols-tumbler.png - \l {Qt.labs.controls::Tumbler}{Tumbler} is a spinnable wheel of items - that can be selected. + \l Tumbler is a spinnable wheel of items that can be selected. */ diff --git a/src/imports/controls/doc/src/qtlabscontrols-navigation.qdoc b/src/imports/controls/doc/src/qtlabscontrols-navigation.qdoc index 639bb139..8d919d45 100644 --- a/src/imports/controls/doc/src/qtlabscontrols-navigation.qdoc +++ b/src/imports/controls/doc/src/qtlabscontrols-navigation.qdoc @@ -27,7 +27,7 @@ /*! \page qtlabscontrols-navigation.html - \title Navigation + \title Navigation Controls Qt Labs Controls offers a selection of navigation models. @@ -36,24 +36,21 @@ The following sections offer guidelines for choosing the appropriate type of navigation model, depending on the use case. - \section1 StackView + \section1 StackView Control \image qtlabscontrols-stackview-wireframe.png - \l {Qt.labs.controls::StackView}{StackView} provides a stack-based navigation - model. + \l StackView provides a stack-based navigation model. - \section1 SwipeView + \section1 SwipeView Control \image qtlabscontrols-swipeview-wireframe.png - \l {Qt.labs.controls::SwipeView}{SwipeView} provides a swipe-based navigation - model. + \l SwipeView provides a swipe-based navigation model. - \section1 TabBar and TabButton + \section1 TabBar and TabButton Controls \image qtlabscontrols-tabbar-wireframe.png - \l {Qt.labs.controls::TabBar}{TabBar} and \l {Qt.labs.controls::TabButton}{TabButton} - provide a tab-based navigation model. + \l TabBar and \l TabButton provide a tab-based navigation model. */ diff --git a/src/templates/qquickapplicationwindow.cpp b/src/templates/qquickapplicationwindow.cpp index b668d0e1..ae64b06b 100644 --- a/src/templates/qquickapplicationwindow.cpp +++ b/src/templates/qquickapplicationwindow.cpp @@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE \note By default, an ApplicationWindow is not visible. - \sa Containers + \sa {Container Controls} */ class QQuickApplicationWindowPrivate : public QQuickItemChangeListener diff --git a/src/templates/qquickbusyindicator.cpp b/src/templates/qquickbusyindicator.cpp index 6bc31496..76196ab8 100644 --- a/src/templates/qquickbusyindicator.cpp +++ b/src/templates/qquickbusyindicator.cpp @@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE } \endqml - \sa {Customizing BusyIndicator}, Indicators + \sa {Customizing BusyIndicator}, {Indicator Controls} */ class QQuickBusyIndicatorPrivate : public QQuickControlPrivate diff --git a/src/templates/qquickbutton.cpp b/src/templates/qquickbutton.cpp index 12234358..179e5bcd 100644 --- a/src/templates/qquickbutton.cpp +++ b/src/templates/qquickbutton.cpp @@ -78,7 +78,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa {Customizing Button}, Buttons + \sa {Customizing Button}, {Button Controls} */ class QQuickButtonPrivate : public QQuickAbstractButtonPrivate diff --git a/src/templates/qquickcheckbox.cpp b/src/templates/qquickcheckbox.cpp index 029cc168..fbcf2c33 100644 --- a/src/templates/qquickcheckbox.cpp +++ b/src/templates/qquickcheckbox.cpp @@ -78,7 +78,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa {Customizing CheckBox}, Buttons + \sa {Customizing CheckBox}, {Button Controls} */ class QQuickCheckBoxPrivate : public QQuickAbstractButtonPrivate diff --git a/src/templates/qquickcontainer.cpp b/src/templates/qquickcontainer.cpp index aeba8ecd..02d90016 100644 --- a/src/templates/qquickcontainer.cpp +++ b/src/templates/qquickcontainer.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE Container is the base type of container-like user interface controls. - \sa Containers + \sa {Container Controls} */ QQuickContainerPrivate::QQuickContainerPrivate() : contentModel(Q_NULLPTR), currentIndex(-1) diff --git a/src/templates/qquickdial.cpp b/src/templates/qquickdial.cpp index 0b533020..4192d9de 100644 --- a/src/templates/qquickdial.cpp +++ b/src/templates/qquickdial.cpp @@ -70,7 +70,7 @@ QT_BEGIN_NAMESPACE \row \li Set \l value to \l to \li \c Qt.Key_End \endtable - \sa {Customizing Dial}, Input + \sa {Customizing Dial}, {Input Controls} */ static const qreal startAngle = -140; diff --git a/src/templates/qquickframe.cpp b/src/templates/qquickframe.cpp index 04837b79..69a7abb0 100644 --- a/src/templates/qquickframe.cpp +++ b/src/templates/qquickframe.cpp @@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-frame.qml 1 - \sa {Customizing Frame}, Containers + \sa {Customizing Frame}, {Container Controls} */ QQuickFramePrivate::QQuickFramePrivate() : contentWidth(0), contentHeight(0), frame(Q_NULLPTR) diff --git a/src/templates/qquickgroupbox.cpp b/src/templates/qquickgroupbox.cpp index 21f81b15..1f1e5f2f 100644 --- a/src/templates/qquickgroupbox.cpp +++ b/src/templates/qquickgroupbox.cpp @@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-groupbox.qml 1 - \sa {Customizing GroupBox}, Containers + \sa {Customizing GroupBox}, {Container Controls} */ class QQuickGroupBoxPrivate : public QQuickFramePrivate diff --git a/src/templates/qquickpageindicator.cpp b/src/templates/qquickpageindicator.cpp index 9708cc8a..18cd33ff 100644 --- a/src/templates/qquickpageindicator.cpp +++ b/src/templates/qquickpageindicator.cpp @@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-pageindicator.qml 1 - \sa SwipeView, {Customizing PageIndicator}, Indicators + \sa SwipeView, {Customizing PageIndicator}, {Indicator Controls} */ class QQuickPageIndicatorPrivate : public QQuickControlPrivate, public QQuickItemChangeListener diff --git a/src/templates/qquickradiobutton.cpp b/src/templates/qquickradiobutton.cpp index 6d9efd6c..a1d1ec25 100644 --- a/src/templates/qquickradiobutton.cpp +++ b/src/templates/qquickradiobutton.cpp @@ -80,7 +80,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa ExclusiveGroup, {Customizing RadioButton}, Buttons + \sa ExclusiveGroup, {Customizing RadioButton}, {Button Controls} */ QQuickRadioButton::QQuickRadioButton(QQuickItem *parent) : diff --git a/src/templates/qquickrangeslider.cpp b/src/templates/qquickrangeslider.cpp index fbdedeb1..df5f1f08 100644 --- a/src/templates/qquickrangeslider.cpp +++ b/src/templates/qquickrangeslider.cpp @@ -73,7 +73,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa {Customizing RangeSlider}, Input + \sa {Customizing RangeSlider}, {Input Controls} */ class QQuickRangeSliderNodePrivate : public QObjectPrivate diff --git a/src/templates/qquickscrollbar.cpp b/src/templates/qquickscrollbar.cpp index 09166a80..559efaaa 100644 --- a/src/templates/qquickscrollbar.cpp +++ b/src/templates/qquickscrollbar.cpp @@ -73,7 +73,7 @@ QT_BEGIN_NAMESPACE \li \l active \endlist - \sa ScrollIndicator, {Customizing ScrollBar}, Indicators + \sa ScrollIndicator, {Customizing ScrollBar}, {Indicator Controls} */ class QQuickScrollBarPrivate : public QQuickControlPrivate diff --git a/src/templates/qquickscrollindicator.cpp b/src/templates/qquickscrollindicator.cpp index 89ddb602..869e784c 100644 --- a/src/templates/qquickscrollindicator.cpp +++ b/src/templates/qquickscrollindicator.cpp @@ -73,7 +73,7 @@ QT_BEGIN_NAMESPACE \li \l active \endlist - \sa ScrollBar, {Customizing ScrollIndicator}, Indicators + \sa ScrollBar, {Customizing ScrollIndicator}, {Indicator Controls} */ class QQuickScrollIndicatorPrivate : public QQuickControlPrivate diff --git a/src/templates/qquickslider.cpp b/src/templates/qquickslider.cpp index b036c839..9e15f1aa 100644 --- a/src/templates/qquickslider.cpp +++ b/src/templates/qquickslider.cpp @@ -68,7 +68,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa {Customizing Slider}, Input + \sa {Customizing Slider}, {Input Controls} */ class QQuickSliderPrivate : public QQuickControlPrivate diff --git a/src/templates/qquickstackview.cpp b/src/templates/qquickstackview.cpp index 19ca9916..33f21c95 100644 --- a/src/templates/qquickstackview.cpp +++ b/src/templates/qquickstackview.cpp @@ -257,7 +257,7 @@ QT_BEGIN_NAMESPACE } \endqml - \sa {Customizing StackView}, Navigation, Containers + \sa {Customizing StackView}, {Navigation Controls}, {Container Controls} */ QQuickStackView::QQuickStackView(QQuickItem *parent) : diff --git a/src/templates/qquickswipeview.cpp b/src/templates/qquickswipeview.cpp index ec949a03..083ee617 100644 --- a/src/templates/qquickswipeview.cpp +++ b/src/templates/qquickswipeview.cpp @@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE \l {Container::moveItem()}{move}, and \l {Container::removeItem()}{remove} pages dynamically at run time. - \sa TabBar, PageIndicator, {Customizing SwipeView}, Navigation, Containers + \sa TabBar, PageIndicator, {Customizing SwipeView}, {Navigation Controls}, {Container Controls} */ class QQuickSwipeViewPrivate : public QQuickContainerPrivate diff --git a/src/templates/qquickswitch.cpp b/src/templates/qquickswitch.cpp index d259e6df..7259e75d 100644 --- a/src/templates/qquickswitch.cpp +++ b/src/templates/qquickswitch.cpp @@ -77,7 +77,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa {Customizing Switch}, Buttons + \sa {Customizing Switch}, {Button Controls} */ class QQuickSwitchPrivate : public QQuickAbstractButtonPrivate diff --git a/src/templates/qquicktabbar.cpp b/src/templates/qquicktabbar.cpp index f859ae3c..6068a832 100644 --- a/src/templates/qquicktabbar.cpp +++ b/src/templates/qquicktabbar.cpp @@ -59,7 +59,7 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-tabbar.qml 1 - \sa TabButton, {Customizing TabBar}, Navigation, Containers + \sa TabButton, {Customizing TabBar}, {Navigation Controls}, {Container Controls} */ class QQuickTabBarPrivate : public QQuickContainerPrivate diff --git a/src/templates/qquicktabbutton.cpp b/src/templates/qquicktabbutton.cpp index e1ee6a9e..deb14a98 100644 --- a/src/templates/qquicktabbutton.cpp +++ b/src/templates/qquicktabbutton.cpp @@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-tabbutton.qml 1 - \sa TabBar, {Customizing TabButton}, Navigation + \sa TabBar, {Customizing TabButton}, {Navigation Controls} */ QQuickTabButton::QQuickTabButton(QQuickItem *parent) : diff --git a/src/templates/qquicktextarea.cpp b/src/templates/qquicktextarea.cpp index c749ba00..0cc34ecb 100644 --- a/src/templates/qquicktextarea.cpp +++ b/src/templates/qquicktextarea.cpp @@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa TextField, {Customizing TextArea}, Input + \sa TextField, {Customizing TextArea}, {Input Controls} */ void QQuickTextAreaPrivate::resizeBackground() diff --git a/src/templates/qquicktextfield.cpp b/src/templates/qquicktextfield.cpp index 30a830cb..945502c9 100644 --- a/src/templates/qquicktextfield.cpp +++ b/src/templates/qquicktextfield.cpp @@ -77,7 +77,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa TextArea, {Customizing TextField}, Input + \sa TextArea, {Customizing TextField}, {Input Controls} */ /*! diff --git a/src/templates/qquicktoolbar.cpp b/src/templates/qquicktoolbar.cpp index a1c06317..fef95100 100644 --- a/src/templates/qquicktoolbar.cpp +++ b/src/templates/qquicktoolbar.cpp @@ -86,7 +86,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa ApplicationWindow, ToolButton, {Customizing ToolBar}, Containers + \sa ApplicationWindow, ToolButton, {Customizing ToolBar}, {Container Controls} */ QQuickToolBar::QQuickToolBar(QQuickItem *parent) : diff --git a/src/templates/qquicktoolbutton.cpp b/src/templates/qquicktoolbutton.cpp index 3c25c0d7..4de82403 100644 --- a/src/templates/qquicktoolbutton.cpp +++ b/src/templates/qquicktoolbutton.cpp @@ -70,7 +70,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa ToolBar, {Customizing ToolButton}, Buttons + \sa ToolBar, {Customizing ToolButton}, {Button Controls} */ QQuickToolButton::QQuickToolButton(QQuickItem *parent) : diff --git a/src/templates/qquicktumbler.cpp b/src/templates/qquicktumbler.cpp index 25c79471..df1120ad 100644 --- a/src/templates/qquicktumbler.cpp +++ b/src/templates/qquicktumbler.cpp @@ -66,7 +66,7 @@ QT_BEGIN_NAMESPACE \image qtlabscontrols-tumbler-wrap.gif - \sa {Customizing Tumbler}, Input + \sa {Customizing Tumbler}, {Input Controls} */ class QQuickTumblerPrivate : public QQuickControlPrivate, public QQuickItemChangeListener |