diff options
author | Caroline Chao <[email protected]> | 2015-03-04 15:31:09 +0100 |
---|---|---|
committer | Caroline Chao <[email protected]> | 2015-03-06 13:20:40 +0000 |
commit | 0e022e36ba45b00986d113cf26161c292adc3a2b (patch) | |
tree | 815b7570ac144176702e1f4ab9ac65e7cd6c40a1 | |
parent | 06e63332054e441ac1c51e19e40399a8accd5db6 (diff) |
Doc: Fix qtdoc warnings
Mostly link errors and missing documentation.
And removed useless references to {QtQuick.Controls.Styles} in the doc.
Change-Id: Iad211a574c0bd23c84e067e0cbcc18c3e719cde7
Reviewed-by: Topi Reiniƶ <[email protected]>
46 files changed, 147 insertions, 98 deletions
diff --git a/src/controls/BusyIndicator.qml b/src/controls/BusyIndicator.qml index fbd6d665e..680106cd9 100644 --- a/src/controls/BusyIndicator.qml +++ b/src/controls/BusyIndicator.qml @@ -59,7 +59,7 @@ import QtQuick.Controls.Private 1.0 \endqml You can create a custom appearance for a Busy Indicator by - assigning a \l {QtQuick.Controls.Styles::BusyIndicatorStyle}{BusyIndicatorStyle}. + assigning a \l {BusyIndicatorStyle}. */ Control { id: indicator diff --git a/src/controls/Button.qml b/src/controls/Button.qml index 6daf595cf..4e7d1b997 100644 --- a/src/controls/Button.qml +++ b/src/controls/Button.qml @@ -61,7 +61,7 @@ import QtQuick.Controls.Private 1.0 Button is similar to the QPushButton widget. You can create a custom appearance for a Button by - assigning a \l {QtQuick.Controls.Styles::ButtonStyle}{ButtonStyle}. + assigning a \l {ButtonStyle}. */ BasicButton { id: button diff --git a/src/controls/Calendar.qml b/src/controls/Calendar.qml index f6a779dbc..9958068a1 100644 --- a/src/controls/Calendar.qml +++ b/src/controls/Calendar.qml @@ -72,7 +72,7 @@ import QtQuick.Controls.Private 1.0 \endqml You can create a custom appearance for Calendar by assigning a - \l {QtQuick.Controls.Styles::CalendarStyle}{CalendarStyle}. + \l {CalendarStyle}. */ Control { diff --git a/src/controls/CheckBox.qml b/src/controls/CheckBox.qml index b5df88467..160696918 100644 --- a/src/controls/CheckBox.qml +++ b/src/controls/CheckBox.qml @@ -87,7 +87,7 @@ import QtQuick.Controls.Private 1.0 Whenever a CheckBox is clicked, it emits the \l {AbstractCheckable::clicked}{clicked()} signal. You can create a custom appearance for a CheckBox by - assigning a \l {QtQuick.Controls.Styles::CheckBoxStyle}{CheckBoxStyle}. + assigning a \l {CheckBoxStyle}. */ AbstractCheckable { diff --git a/src/controls/ComboBox.qml b/src/controls/ComboBox.qml index 81d56030b..9eb63fe76 100644 --- a/src/controls/ComboBox.qml +++ b/src/controls/ComboBox.qml @@ -99,7 +99,7 @@ import QtQuick.Controls.Private 1.0 You can create a custom appearance for a ComboBox by - assigning a \l {QtQuick.Controls.Styles::ComboBoxStyle}{ComboBoxStyle}. + assigning a \l {ComboBoxStyle}. */ Control { @@ -194,8 +194,8 @@ Control { an intermediate state. The accepted signal will only be sent if the text is in an acceptable state when enter is pressed. - Currently supported validators are \l{QtQuick::}{IntValidator}, - \l{QtQuick::}{DoubleValidator}, and \l{QtQuick::}{RegExpValidator}. An + Currently supported validators are \l[QtQuick]{IntValidator}, + \l[QtQuick]{DoubleValidator}, and \l[QtQuick]{RegExpValidator}. An example of using validators is shown below, which allows input of integers between 11 and 31 into the text field: diff --git a/src/controls/Menu.qml b/src/controls/Menu.qml index 17b27977d..0cee85a6a 100644 --- a/src/controls/Menu.qml +++ b/src/controls/Menu.qml @@ -127,6 +127,13 @@ MenuPrivate { /*! \internal */ property Component __selfComponent: null + /*! \qmlproperty Component Menu::style + \since QtQuick.Controls.Styles 1.2 + + The style Component for this control. + \sa {MenuStyle} + + */ property Component style Component.onCompleted: { diff --git a/src/controls/MenuBar.qml b/src/controls/MenuBar.qml index 0c0a20041..7a92c1ecd 100644 --- a/src/controls/MenuBar.qml +++ b/src/controls/MenuBar.qml @@ -77,6 +77,13 @@ import QtQuick.Controls.Private 1.0 MenuBarPrivate { id: root + /*! \qmlproperty Component MenuBar::style + \since QtQuick.Controls.Styles 1.2 + + The style Component for this control. + \sa {MenuBarStyle} + + */ property Component style: Settings.styleComponent(Settings.style, "MenuBarStyle.qml", root) /*! \internal */ diff --git a/src/controls/ProgressBar.qml b/src/controls/ProgressBar.qml index 681cb1353..23e56274f 100644 --- a/src/controls/ProgressBar.qml +++ b/src/controls/ProgressBar.qml @@ -62,7 +62,7 @@ import QtQuick.Controls.Private 1.0 \endcode You can create a custom appearance for a ProgressBar by - assigning a \l {QtQuick.Controls.Styles::ProgressBarStyle}{ProgressBarStyle}. + assigning a \l {ProgressBarStyle}. */ Control { diff --git a/src/controls/RadioButton.qml b/src/controls/RadioButton.qml index b03028a13..a7808a5cc 100644 --- a/src/controls/RadioButton.qml +++ b/src/controls/RadioButton.qml @@ -73,7 +73,7 @@ import QtQuick.Controls.Private 1.0 \endqml You can create a custom appearance for a RadioButton by - assigning a \l {QtQuick.Controls.Styles::RadioButtonStyle}{RadioButtonStyle}. + assigning a \l {RadioButtonStyle}. */ AbstractCheckable { diff --git a/src/controls/ScrollView.qml b/src/controls/ScrollView.qml index c82bb7e59..856a32ef2 100644 --- a/src/controls/ScrollView.qml +++ b/src/controls/ScrollView.qml @@ -79,7 +79,7 @@ import QtQuick.Controls.Styles 1.1 \l flickableItem. You can create a custom appearance for a ScrollView by - assigning a \l {QtQuick.Controls.Styles::ScrollViewStyle}{ScrollViewStyle}. + assigning a \l {ScrollViewStyle}. */ FocusScope { diff --git a/src/controls/Slider.qml b/src/controls/Slider.qml index 437749eba..20d11025d 100644 --- a/src/controls/Slider.qml +++ b/src/controls/Slider.qml @@ -61,7 +61,7 @@ import QtQuick.Controls.Private 1.0 needed, you can set the \l stepSize. You can create a custom appearance for a Slider by - assigning a \l {QtQuick.Controls.Styles::SliderStyle}{SliderStyle}. + assigning a \l {SliderStyle}. */ Control { diff --git a/src/controls/StackView.qml b/src/controls/StackView.qml index e2fd7722d..77dc4ea7c 100644 --- a/src/controls/StackView.qml +++ b/src/controls/StackView.qml @@ -294,7 +294,7 @@ import QtQuick.Controls.Private 1.0 When the transition starts, the StackView will search for a transition that matches the operation executed. There are three transitions to choose - from: pushTransition, popTransition, and replaceTransition. Each implements how + from: \l {StackViewDelegate::}{pushTransition}, \l {StackViewDelegate::}{popTransition}, and \l {StackViewDelegate::}{replaceTransition}. Each implements how enterItem should animate in, and exitItem out. The transitions are collected inside a StackViewDelegate object assigned to \l {StackView::delegate}{delegate}. By default, popTransition and @@ -484,7 +484,7 @@ FocusScope { */ readonly property alias currentItem: root.__currentItem - /*! The first \l item that should be shown when the StackView is created. + /*! The first item that should be shown when the StackView is created. \a initialItem can take same value as the first argument to \l{StackView::push()} {StackView.push()}. Note that this is just a convenience for writing \c{Component.onCompleted: stackView.push(myInitialItem)} @@ -506,7 +506,7 @@ FocusScope { /*! The transitions to use when pushing or popping items. For better understanding on how to apply custom transitions, read \l{Transitions}. - \sa {Stack::transitions}{Stack.transitions} */ + \sa {Transitions} */ property StackViewDelegate delegate: StackViewSlideDelegate {} /*! Pushes an item onto the stack. The function takes a property list as argument, which diff --git a/src/controls/StackViewDelegate.qml b/src/controls/StackViewDelegate.qml index 6f99def45..1d4c2969d 100644 --- a/src/controls/StackViewDelegate.qml +++ b/src/controls/StackViewDelegate.qml @@ -49,16 +49,45 @@ import QtQuick 2.2 QtObject { id: root + /*! + \qmlmethod StackViewDelegate::getTransition(properties) + + The base implementation of this function just looks for a property named properties.name inside itself. + \sa {Transitions} + */ function getTransition(properties) { return root[properties.name] } + /*! + \qmlmethod StackViewDelegate::transitionFinished(properties) + + The base implementation of this function is empty. + \sa {Transitions} + */ function transitionFinished(properties) { } + /*! + \qmlproperty Component StackViewDelegate::pushTransition + + The transition used on push operation. + */ property Component pushTransition: StackViewTransition {} + /*! + \qmlproperty Component StackViewDelegate::popTransition + + The transition used on pop operation. + Unless set, the popTransition is the same as pushTransition + */ property Component popTransition: root["pushTransition"] + /*! + \qmlproperty Component StackViewDelegate::replaceTransition + + The transition used on replace operation. + Unless set, the replaceTransition is the same as pushTransition + */ property Component replaceTransition: root["pushTransition"] } diff --git a/src/controls/StatusBar.qml b/src/controls/StatusBar.qml index 74df9439a..f151a3ac4 100644 --- a/src/controls/StatusBar.qml +++ b/src/controls/StatusBar.qml @@ -81,7 +81,12 @@ FocusScope { implicitHeight: container.topMargin + container.bottomMargin + Math.max(container.layoutHeight, __panel ? __panel.implicitHeight : 0) - /*! \internal */ + /*! \qmlproperty Component StatusBar::style + + The style Component for this control. + \sa {StatusBarStyle} + + */ property Component style: Settings.styleComponent(Settings.style, "StatusBarStyle.qml", statusbar) /*! \internal */ diff --git a/src/controls/Styles/Base/BasicTableViewStyle.qml b/src/controls/Styles/Base/BasicTableViewStyle.qml index b395b6fd2..3c5e45123 100644 --- a/src/controls/Styles/Base/BasicTableViewStyle.qml +++ b/src/controls/Styles/Base/BasicTableViewStyle.qml @@ -47,7 +47,7 @@ import QtQuick.Controls.Private 1.0 \ingroup viewsstyling \brief Provides custom styling for TableView - \note This class derives from \l {QtQuick.Controls.Styles::}{ScrollViewStyle} + \note This class derives from \l {ScrollViewStyle} and supports all of the properties defined there. */ ScrollViewStyle { @@ -74,7 +74,7 @@ ScrollViewStyle { padding.top: control.headerVisible ? 0 : 1 /*! \qmlproperty Component BasicTableViewStyle::headerDelegate - Delegate for header. This delegate is described in \l {TableView::headerDelegate} + Delegate for header. This delegate is described in \l {TreeView}{TreeView.headerDelegate} and \l {TableView}{TableView.headerDelegate} */ property Component headerDelegate: BorderImage { height: textItem.implicitHeight * 1.2 @@ -105,7 +105,7 @@ ScrollViewStyle { } /*! \qmlproperty Component BasicTableViewStyle::rowDelegate - Delegate for row. This delegate is described in \l {TableView::rowDelegate} + Delegate for row. This delegate is described in \l {TreeView}{TreeView.rowDelegate} and \l {TableView}{TableView.rowDelegate} */ property Component rowDelegate: Rectangle { height: Math.round(TextSingleton.implicitHeight * 1.2) @@ -115,7 +115,7 @@ ScrollViewStyle { } /*! \qmlproperty Component BasicTableViewStyle::itemDelegate - Delegate for item. This delegate is described in \l {TableView::itemDelegate} + Delegate for item. This delegate is described in \l {TreeView}{TreeView.itemDelegate} and \l {TableView}{TableView.itemDelegate} */ property Component itemDelegate: Item { height: Math.max(16, label.implicitHeight) diff --git a/src/controls/Styles/Base/DelayButtonStyle.qml b/src/controls/Styles/Base/DelayButtonStyle.qml index 447932b72..12f545bed 100644 --- a/src/controls/Styles/Base/DelayButtonStyle.qml +++ b/src/controls/Styles/Base/DelayButtonStyle.qml @@ -50,7 +50,7 @@ import QtQuick.Extras.Private.CppUtils 1.1 You can create a custom DelayButton by replacing the following delegates: \list \li \l foreground - \li \l {QtQuick.Controls.Styles::ButtonStyle::label}{label} + \li \l {ButtonStyle::}{label} \endlist */ diff --git a/src/controls/Styles/Base/MenuBarStyle.qml b/src/controls/Styles/Base/MenuBarStyle.qml index 7b8a7aad2..aaad65e82 100644 --- a/src/controls/Styles/Base/MenuBarStyle.qml +++ b/src/controls/Styles/Base/MenuBarStyle.qml @@ -109,7 +109,7 @@ Style { /*! The style component for the menubar's own menus and their submenus. - \sa {QtQuick.Controls.Styles::}{MenuStyle} + \sa {MenuStyle} */ property Component menuStyle: MenuStyle { font: root.font diff --git a/src/controls/Styles/Base/StatusBarStyle.qml b/src/controls/Styles/Base/StatusBarStyle.qml index e98b0dfb2..2b5730408 100644 --- a/src/controls/Styles/Base/StatusBarStyle.qml +++ b/src/controls/Styles/Base/StatusBarStyle.qml @@ -87,7 +87,7 @@ Style { bottom: 2 } - /*! This defines the background of the tool bar. */ + /*! This defines the background of the status bar. */ property Component background: Rectangle { implicitHeight: 16 implicitWidth: 200 @@ -105,6 +105,7 @@ Style { } } + /*! This defines the panel of the status bar. */ property Component panel: Loader { sourceComponent: background } diff --git a/src/controls/Styles/Base/StatusIndicatorStyle.qml b/src/controls/Styles/Base/StatusIndicatorStyle.qml index 62ed1038e..4366d1f72 100644 --- a/src/controls/Styles/Base/StatusIndicatorStyle.qml +++ b/src/controls/Styles/Base/StatusIndicatorStyle.qml @@ -60,9 +60,9 @@ Style { /*! The color that instances of - \l {QtQuick.Extras::}{StatusIndicator} will have. - The \l {QtQuick.Extras::StatusIndicator::}{color} - property in \l {QtQuick.Extras::}{StatusIndicator} + \l [QtQuickExtras]{StatusIndicator} will have. + The \l [QtQuickExtras]{StatusIndicator::}{color} + property in \l [QtQuickExtras]{StatusIndicator} will override this property when set. */ property color color: "red" diff --git a/src/controls/Styles/Base/TableViewStyle.qml b/src/controls/Styles/Base/TableViewStyle.qml index 2e3224659..ddf15cef7 100644 --- a/src/controls/Styles/Base/TableViewStyle.qml +++ b/src/controls/Styles/Base/TableViewStyle.qml @@ -44,7 +44,7 @@ import QtQuick.Controls 1.4 \ingroup viewsstyling \brief Provides custom styling for TableView - \note This class derives from \l {QtQuick.Controls.Styles::}{ScrollViewStyle} + \note This class derives from \l {ScrollViewStyle} and supports all of the properties defined there. */ BasicTableViewStyle { diff --git a/src/controls/Styles/Base/ToggleButtonStyle.qml b/src/controls/Styles/Base/ToggleButtonStyle.qml index de06d72bc..ca1850122 100644 --- a/src/controls/Styles/Base/ToggleButtonStyle.qml +++ b/src/controls/Styles/Base/ToggleButtonStyle.qml @@ -49,7 +49,7 @@ import QtQuick.Extras.Private.CppUtils 1.0 \brief Provides custom styling for ToggleButton. You can create a custom toggle button by replacing the same delegates that - \l {QtQuick.Controls.Styles::ButtonStyle}{ButtonStyle} provides. + \l {ButtonStyle} provides. */ CircularButtonStyle { diff --git a/src/controls/Styles/Base/ToolBarStyle.qml b/src/controls/Styles/Base/ToolBarStyle.qml index 708ffd30b..503d908bf 100644 --- a/src/controls/Styles/Base/ToolBarStyle.qml +++ b/src/controls/Styles/Base/ToolBarStyle.qml @@ -116,6 +116,7 @@ Style { */ property Component menuButton: null + /*! This defines the panel of the tool bar. */ property Component panel: Loader { sourceComponent: background } diff --git a/src/controls/Switch.qml b/src/controls/Switch.qml index d416b7f33..a27bf9c93 100644 --- a/src/controls/Switch.qml +++ b/src/controls/Switch.qml @@ -63,7 +63,7 @@ import QtQuick.Controls.Private 1.0 \endqml You can create a custom appearance for a Switch by - assigning a \l {QtQuick.Controls.Styles::SwitchStyle}{SwitchStyle}. + assigning a \l {SwitchStyle}. */ Control { diff --git a/src/controls/TabView.qml b/src/controls/TabView.qml index ea8bf4bd5..84e5331b6 100644 --- a/src/controls/TabView.qml +++ b/src/controls/TabView.qml @@ -69,7 +69,7 @@ import QtQuick.Controls.Private 1.0 \endqml \note You can create a custom appearance for a TabView by - assigning a \l {QtQuick.Controls.Styles::TabViewStyle}{TabViewStyle}. + assigning a \l {TabViewStyle}. \l Tab represents the content of a tab in a TabView. */ diff --git a/src/controls/TableView.qml b/src/controls/TableView.qml index e43577391..e35f41878 100644 --- a/src/controls/TableView.qml +++ b/src/controls/TableView.qml @@ -93,8 +93,8 @@ import QtQuick.Window 2.1 the model role they attach to. Each property in the model will then be shown in their corresponding column. - You can customize the look by overriding the \l itemDelegate, - \l rowDelegate, or \l headerDelegate properties. + You can customize the look by overriding the \l {BasicTableView::}{itemDelegate}, + \l {BasicTableView::}{rowDelegate}, or \l {BasicTableView::}{headerDelegate} properties. The view itself does not provide sorting. This has to be done on the model itself. However you can provide sorting @@ -107,7 +107,7 @@ import QtQuick.Window 2.1 \endlist You can create a custom appearance for a TableView by - assigning a \l {QtQuick.Controls.Styles::TableViewStyle}{TableViewStyle}. + assigning a \l {TableViewStyle}. */ BasicTableView { @@ -222,7 +222,7 @@ BasicTableView { Depending on how the model is populated, the model may not be ready when TableView Component.onCompleted is called. In that case you may need to - delay the call to positionViewAtRow by using a \l {QtQml::Timer}{Timer}. + delay the call to positionViewAtRow by using a \l [QtQml]{Timer}. \note This method should only be called after the component has completed. */ diff --git a/src/controls/TableViewColumn.qml b/src/controls/TableViewColumn.qml index bffa67617..53b9ed774 100644 --- a/src/controls/TableViewColumn.qml +++ b/src/controls/TableViewColumn.qml @@ -101,7 +101,7 @@ QtObject { \li Text.ElideMiddle \li Text.ElideRight - the default \endlist - \sa {QtQuick::}{Text::elide} */ + \sa {Text::elide}{elide} */ property int elideMode: Text.ElideRight /*! \qmlproperty enumeration TableViewColumn::horizontalAlignment @@ -113,11 +113,11 @@ QtObject { \li Text.AlignHCenter \li Text.AlignJustify \endlist - \sa {QtQuick::}{Text::horizontalAlignment} */ + \sa {Text::horizontalAlignment}{horizontalAlignment} */ property int horizontalAlignment: Text.AlignLeft - /*! The delegate of the column. This can be used to set the - \l TableView::itemDelegate or TreeView::itemDelegate for a specific column. + /*! The delegate of the column. This can be used to set the itemDelagate + of a \l TableView or \l TreeView for a specific column. In the delegate you have access to the following special properties: \list diff --git a/src/controls/TextArea.qml b/src/controls/TextArea.qml index c141f9e2f..54a297069 100644 --- a/src/controls/TextArea.qml +++ b/src/controls/TextArea.qml @@ -67,7 +67,7 @@ import QtQuick.Controls.Private 1.0 points using positionAt() and positionToRectangle(). You can create a custom appearance for a TextArea by - assigning a \l{QtQuick.Controls.Styles::TextAreaStyle}{TextAreaStyle}. + assigning a \l {TextAreaStyle}. \sa TextField, TextEdit */ diff --git a/src/controls/TextField.qml b/src/controls/TextField.qml index db42cfb77..010561d39 100644 --- a/src/controls/TextField.qml +++ b/src/controls/TextField.qml @@ -59,7 +59,7 @@ import QtQuick.Controls.Private 1.0 \endqml You can create a custom appearance for a TextField by - assigning a \l {QtQuick.Controls.Styles::TextFieldStyle}{TextFieldStyle}. + assigning a \l {TextFieldStyle}. \sa TextArea, TextInput */ @@ -411,8 +411,8 @@ Control { an intermediate state. The accepted signal will only be sent if the text is in an acceptable state when enter is pressed. - Currently supported validators are \l{QtQuick::}{IntValidator}, - \l{QtQuick::}{DoubleValidator}, and \l{QtQuick::}{RegExpValidator}. An + Currently supported validators are \l[QtQuick]{IntValidator}, + \l[QtQuick]{DoubleValidator}, and \l[QtQuick]{RegExpValidator}. An example of using validators is shown below, which allows input of integers between 11 and 31 into the text input: diff --git a/src/controls/ToolButton.qml b/src/controls/ToolButton.qml index a9904e119..8d672afad 100644 --- a/src/controls/ToolButton.qml +++ b/src/controls/ToolButton.qml @@ -50,10 +50,10 @@ import QtQuick.Controls.Private 1.0 ToolButton is functionally similar to \l {QtQuick.Controls::}{Button}, but can provide a look that is more suitable within a \l ToolBar. - \qml + \code ApplicationWindow { ... - toolBar:ToolBar { + toolBar: ToolBar { RowLayout { ToolButton { iconSource: "new.png" @@ -72,10 +72,10 @@ import QtQuick.Controls.Private 1.0 } } } - \endqml + \endcode You can create a custom appearance for a ToolButton by - assigning a \l {QtQuick.Controls.Styles::ButtonStyle}{ButtonStyle}. + assigning a \l {ButtonStyle}. */ Button { diff --git a/src/controls/TreeView.qml b/src/controls/TreeView.qml index f1175b727..b73a24392 100644 --- a/src/controls/TreeView.qml +++ b/src/controls/TreeView.qml @@ -77,8 +77,8 @@ import QtQml.Models 2.2 the model role they attach to. Each property in the model will then be shown in their corresponding column. - You can customize the look by overriding the \l itemDelegate, - \l rowDelegate, or \l headerDelegate properties. + You can customize the look by overriding the \l {BasicTableView::itemDelegate}{itemDelegate}, + \l {BasicTableView::rowDelegate}{rowDelegate}, or \l {BasicTableView::headerDelegate}{headerDelegate} properties. The view itself does not provide sorting. This has to be done on the model itself. However you can provide sorting @@ -91,7 +91,7 @@ import QtQml.Models 2.2 \endlist You can create a custom appearance for a TreeView by - assigning a \l {QtQuick.Controls.Styles::TreeViewStyle}{TreeViewStyle}. + assigning a \l {TreeViewStyle}. */ BasicTableView { diff --git a/src/controls/doc/src/qtquickcontrols-examples.qdoc b/src/controls/doc/src/qtquickcontrols-examples.qdoc index 3418d6c29..5cb564905 100644 --- a/src/controls/doc/src/qtquickcontrols-examples.qdoc +++ b/src/controls/doc/src/qtquickcontrols-examples.qdoc @@ -106,9 +106,9 @@ QML namespace import: - \qml + \code import org.qtproject.example 1.0 - \endqml + \endcode For more information about registering C++ classses as QML types, see \l {Defining QML Types from C++}. @@ -147,9 +147,9 @@ QML namespace import: - \qml + \code import org.qtproject.example 1.0 - \endqml + \endcode For more information about registering C++ classses as QML types, see \l {Defining QML Types from C++}. @@ -249,7 +249,7 @@ The stack is used by invoking its navigation methods. To load the first item in the stack view, we assign it to \c initialItem: - \printuntil \printuntil /^\}/ + \printuntil /^\}/ We use a ListView type to display a list of the items provided by \c pageModel. The \c AndroidDelegate custom type defines each item @@ -443,7 +443,7 @@ \skipto SqlEventModel::SqlEventModel() \printto QList \skipto void SqlEventModel - \printuntil /\^} + \printuntil /^\}/ In \e main.qml, the SqlEventModel custom type is used to get the list of events to mark the dates on the calendar. diff --git a/src/controls/doc/src/styling-circulargauge.qdoc b/src/controls/doc/src/styling-circulargauge.qdoc index e0260db48..9a3300410 100644 --- a/src/controls/doc/src/styling-circulargauge.qdoc +++ b/src/controls/doc/src/styling-circulargauge.qdoc @@ -82,7 +82,7 @@ \list A \li Change the color of the tickmarks depending on \c styleData.value \li Add an image to the background - \li Draw it with \l {QtQuick::}{Canvas} + \li Draw it with \l [QtQuick]{Canvas} \endlist We'll choose options 1 and 3, as they are more flexible than using an @@ -126,7 +126,7 @@ \snippet circulargauge-background-range.qml background We define a function to convert degrees to radians, which are the - units used by \l {QtQuick::}{Canvas}. + units used by \l [QtQuick]{Canvas}. Next, we do the drawing of the range using Canvas. We draw an arc between \c 80 and \c 100, using the diff --git a/src/controls/qquickaction.cpp b/src/controls/qquickaction.cpp index 07850b5af..e3512baf8 100644 --- a/src/controls/qquickaction.cpp +++ b/src/controls/qquickaction.cpp @@ -68,7 +68,7 @@ QT_BEGIN_NAMESPACE \quotefromfile gallery/main.qml \dots \skipto Action - \printto SystemPalette + \printto TabView \dots */ diff --git a/src/controls/qquickmenu.cpp b/src/controls/qquickmenu.cpp index bc1169a7c..85bb44968 100644 --- a/src/controls/qquickmenu.cpp +++ b/src/controls/qquickmenu.cpp @@ -113,7 +113,7 @@ QT_BEGIN_NAMESPACE /*! \qmlproperty enumeration Menu::type - This property is read-only and constant, and its value is \l MenuItemType.Menu. + This property is read-only and constant, and its value is \l {QtQuick.Controls::MenuItem::}{type}. */ /*! diff --git a/src/dialogs/doc/qtquickdialogs.qdocconf b/src/dialogs/doc/qtquickdialogs.qdocconf index fbad85a50..2dd08ed6f 100644 --- a/src/dialogs/doc/qtquickdialogs.qdocconf +++ b/src/dialogs/doc/qtquickdialogs.qdocconf @@ -22,7 +22,7 @@ qhp.QtQuickDialogs.subprojects.qtquickdialogsqmltypes.indexTitle = Qt Quick Dial qhp.QtQuickDialogs.subprojects.qtquickdialogsqmltypes.selectors = qmlclass qhp.QtQuickDialogs.subprojects.qtquickdialogsqmltypes.sortPages = true -depends = qtqml qtquick qtgui qtwidgets qtdoc +depends = qtqml qtquick qtgui qtwidgets qtdoc qtcore exampledirs += ../../../examples/quick/dialogs diff --git a/src/dialogs/qquickplatformfiledialog.cpp b/src/dialogs/qquickplatformfiledialog.cpp index d6b74b77f..2bc59c744 100644 --- a/src/dialogs/qquickplatformfiledialog.cpp +++ b/src/dialogs/qquickplatformfiledialog.cpp @@ -96,7 +96,7 @@ QT_BEGIN_NAMESPACE The QML implementation has a sidebar containing shortcuts to common platform-specific locations, and user-modifiable shortcuts. It uses - application-specific \l {Qt.labs.settings::Settings} {settings} to store + application-specific \l {Qt.labs.settings}{settings} to store these bookmarks, as well as other user-modifiable state, such as whether or not the sidebar is shown, the positions of the splitters, and the dialog size. The settings are stored in a section called \c QQControlsFileDialog @@ -109,7 +109,7 @@ QT_BEGIN_NAMESPACE \l {QCoreApplication::organizationName}{organization} and \l {QCoreApplication::organizationDomain}{domain} in order to control the location of the application's settings. If you use - \l {Qt.labs.settings::Settings} {Settings} objects in other parts of an + \l {Qt.labs.settings}{Settings} objects in other parts of an application, they will be stored in other sections of the same file. \l QFileDialog stores its settings globally instead of per-application. @@ -353,7 +353,7 @@ QPlatformFileDialogHelper *QQuickPlatformFileDialog::helper() This property holds whether the sidebar in the dialog containing shortcuts and bookmarks is visible. By default it depends on the setting stored in the \c QQControlsFileDialog section of the application's - \l {Qt.labs.settings::Settings} {Settings}. + \l {Qt.labs.settings}{Settings}. \since 5.4 */ diff --git a/src/extras/CircularGauge.qml b/src/extras/CircularGauge.qml index 426d6e49a..c3bb7fff8 100644 --- a/src/extras/CircularGauge.qml +++ b/src/extras/CircularGauge.qml @@ -58,9 +58,9 @@ import QtQuick.Extras.Private 1.0 The minimum and maximum values displayable by the gauge can be set with the \l minimumValue and \l maximumValue properties. The angle at which these values are displayed can be set with the - \l {QtQuick.Controls.Styles::CircularGaugeStyle::}{minimumValueAngle} and - \l {QtQuick.Controls.Styles::CircularGaugeStyle::}{maximumValueAngle} properties of - \l {QtQuick.Controls.Styles::}{CircularGaugeStyle}. + \l {CircularGaugeStyle::}{minimumValueAngle} and + \l {CircularGaugeStyle::}{maximumValueAngle} properties of + \l {CircularGaugeStyle}. Example: \code @@ -89,7 +89,7 @@ import QtQuick.Extras.Private 1.0 \endcode You can create a custom appearance for a CircularGauge by assigning a - \l {QtQuick.Controls.Styles::}{CircularGaugeStyle}. + \l {CircularGaugeStyle}. */ Control { @@ -136,13 +136,13 @@ Control { For more fine-grained control over what is displayed, the following style components of - \l {QtQuick.Controls.Styles::}{CircularGaugeStyle} can be + \l CircularGaugeStyle can be used: \list - \li \l {QtQuick.Controls.Styles::CircularGaugeStyle::tickmark}{tickmark} - \li \l {QtQuick.Controls.Styles::CircularGaugeStyle::minorTickmark}{minorTickmark} - \li \l {QtQuick.Controls.Styles::CircularGaugeStyle::tickmarkLabel}{tickmarkLabel} + \li \l {CircularGaugeStyle::}{tickmark} + \li \l {CircularGaugeStyle::}{minorTickmark} + \li \l {CircularGaugeStyle::}{tickmarkLabel} \endlist */ property bool tickmarksVisible: true diff --git a/src/extras/DelayButton.qml b/src/extras/DelayButton.qml index f855e90ec..476b7702e 100644 --- a/src/extras/DelayButton.qml +++ b/src/extras/DelayButton.qml @@ -67,7 +67,7 @@ import QtQuick.Controls.Private 1.0 A DelayButton after being activated You can create a custom appearance for a DelayButton by assigning a - \l {QtQuick.Controls.Styles::}{DelayButtonStyle}. + \l {DelayButtonStyle}. */ Button { diff --git a/src/extras/Dial.qml b/src/extras/Dial.qml index 4454c90d0..eccab6483 100644 --- a/src/extras/Dial.qml +++ b/src/extras/Dial.qml @@ -57,11 +57,11 @@ import QtQuick.Extras.Private 1.0 Like CircularGauge, Dial can display tickmarks to give an indication of the current value. When a suitable stepSize is combined with - \l {QtQuick.Controls.Styles::DialStyle::}{tickmarkStepSize}, + \l {DialStyle::}{tickmarkStepSize}, the dial "snaps" to each tickmark. You can create a custom appearance for a Dial by assigning a - \l {QtQuick.Controls.Styles::}{DialStyle}. + \l {DialStyle}. */ Control { @@ -149,12 +149,12 @@ Control { For more fine-grained control over what is displayed, the following style components of - \l {QtQuick.Controls.Styles::}{DialStyle} can be used: + \l {DialStyle} can be used: \list - \li \l {QtQuick.Controls.Styles::DialStyle::tickmark}{tickmark} - \li \l {QtQuick.Controls.Styles::DialStyle::minorTickmark}{minorTickmark} - \li \l {QtQuick.Controls.Styles::DialStyle::tickmarkLabel}{tickmarkLabel} + \li \l {DialStyle::}{tickmark} + \li \l {DialStyle::}{minorTickmark} + \li \l {DialStyle::}{tickmarkLabel} \endlist The default value is \c true. diff --git a/src/extras/Gauge.qml b/src/extras/Gauge.qml index f5a0071e0..1853af583 100644 --- a/src/extras/Gauge.qml +++ b/src/extras/Gauge.qml @@ -70,7 +70,7 @@ import QtQuick.Extras.Private 1.0 \endcode You can create a custom appearance for a Gauge by assigning a - \l {QtQuick.Controls.Styles::}{GaugeStyle}. + \l {GaugeStyle}. */ Control { @@ -174,7 +174,7 @@ Control { /*! This property accepts a function that formats the given \a value for display in - \l {QtQuick.Controls.Styles::GaugeStyle}{tickmarkLabel}. + \l {GaugeStyle::}{tickmarkLabel}. For example, to provide a custom format that displays all values with 3 decimal places: diff --git a/src/extras/PieMenu.qml b/src/extras/PieMenu.qml index d667a9a80..49698c155 100644 --- a/src/extras/PieMenu.qml +++ b/src/extras/PieMenu.qml @@ -147,12 +147,11 @@ import QtQuick.Extras.Private.CppUtils 1.0 as CppUtils You can hide individual menu items by setting their visible property to \c false. Hiding items does not affect the - \l {QtQuick.Controls.Styles::PieMenuStyle::}{startAngle} or - \l {QtQuick.Controls.Styles::PieMenuStyle::}{endAngle}; the + \l {PieMenuStyle::}{startAngle} or + \l {PieMenuStyle::}{endAngle}; the remaining items will grow to consume the available space. - You can create a custom appearance for a PieMenu by assigning a - \l {QtQuick.Controls.Styles::}{PieMenuStyle}. + You can create a custom appearance for a PieMenu by assigning a \l {PieMenuStyle} */ Control { diff --git a/src/extras/StatusIndicator.qml b/src/extras/StatusIndicator.qml index a49df4967..7348833d3 100644 --- a/src/extras/StatusIndicator.qml +++ b/src/extras/StatusIndicator.qml @@ -82,7 +82,7 @@ import QtQuick.Extras.Private 1.0 \endtable You can create a custom appearance for a StatusIndicator by assigning a - \l {QtQuick.Controls.Styles::}{StatusIndicatorStyle}. + \l {StatusIndicatorStyle}. */ Control { diff --git a/src/extras/ToggleButton.qml b/src/extras/ToggleButton.qml index ca08e36f5..a26ac2867 100644 --- a/src/extras/ToggleButton.qml +++ b/src/extras/ToggleButton.qml @@ -58,7 +58,7 @@ import QtQuick.Controls.Private 1.0 placing color-coded indicators around the button. You can create a custom appearance for a ToggleButton by assigning a - \l {QtQuick.Controls.Styles::}{ToggleButtonStyle}. + \l {ToggleButtonStyle}. */ Button { diff --git a/src/extras/Tumbler.qml b/src/extras/Tumbler.qml index 561515b2d..4743322b7 100644 --- a/src/extras/Tumbler.qml +++ b/src/extras/Tumbler.qml @@ -122,13 +122,13 @@ import QtQuick.Layouts 1.0 \section1 Limitations For technical reasons, the model count must be equal to or greater than - \l {QtQuick.Controls.Styles::TumblerStyle}{visibleItemCount} + \l {TumblerStyle::}{visibleItemCount} plus one. The - \l {QtQuick.Controls.Styles::TumblerStyle::}{visibleItemCount} + \l {TumblerStyle::}{visibleItemCount} must also be an odd number. You can create a custom appearance for a Tumbler by assigning a - \l {QtQuick.Controls.Styles::}{TumblerStyle}. To style + \l {TumblerStyle}. To style individual columns, use the \l {TumblerColumn::delegate}{delegate} and \l {TumblerColumn::highlight}{highlight} properties of TumblerColumn. */ diff --git a/src/extras/TumblerColumn.qml b/src/extras/TumblerColumn.qml index 481f08698..6dfecb04c 100644 --- a/src/extras/TumblerColumn.qml +++ b/src/extras/TumblerColumn.qml @@ -64,7 +64,7 @@ import QtQuick.Controls.Private 1.0 \endcode You can create a custom appearance for a Tumbler by assigning a - \l {QtQuick.Controls.Styles::}{TumblerStyle}. + \l {TumblerStyle}. */ QtObject { @@ -116,8 +116,8 @@ QtObject { If set, this delegate will be used to display items in this column, instead of the - \l {QtQuick.Controls.Styles::TumblerStyle::delegate}{delegate} - property in \l {QtQuick.Controls.Styles::}{TumblerStyle}. + \l {TumblerStyle::}{delegate} + property in \l {TumblerStyle}. The \l {Item::implicitHeight}{implicitHeight} property must be set, and it must be the same for each delegate. @@ -129,8 +129,8 @@ QtObject { If set, this highlight will be used to display the highlight in this column, instead of the - \l {QtQuick.Controls.Styles::TumblerStyle::highlight}{highlight} - property in \l {QtQuick.Controls.Styles::}{TumblerStyle}. + \l {TumblerStyle::}{highlight} + property in \l {TumblerStyle}. */ property Component highlight @@ -139,8 +139,8 @@ QtObject { If set, this component will be used to display the foreground in this column, instead of the - \l {QtQuick.Controls.Styles::TumblerStyle::columnForeground}{columnForeground} - property in \l {QtQuick.Controls.Styles::}{TumblerStyle}. + \l {TumblerStyle::}{columnForeground} + property in \l {TumblerStyle}. */ property Component columnForeground diff --git a/src/extras/doc/src/qtquickextras-examples.qdoc b/src/extras/doc/src/qtquickextras-examples.qdoc index c966e48d0..41043c866 100644 --- a/src/extras/doc/src/qtquickextras-examples.qdoc +++ b/src/extras/doc/src/qtquickextras-examples.qdoc @@ -35,7 +35,7 @@ */ /*! - \example extras/gallery + \example gallery \title Qt Quick Extras - Gallery \ingroup qtquickextras-examples \brief An interactive showcase of the various controls. @@ -46,7 +46,7 @@ */ /*! - \example extras/dashboard + \example dashboard \title Qt Quick Extras - Dashboard \ingroup qtquickextras-examples \brief A car dashboard created using several CircularGauge controls. @@ -56,7 +56,7 @@ */ /*! - \example extras/flat + \example flat \title Qt Quick Extras - Flat \ingroup qtquickextras-examples \brief An interactive showcase of the flat style. |