diff options
| author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2019-11-14 08:27:10 +0100 |
|---|---|---|
| committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2019-11-26 13:51:32 +0100 |
| commit | 8ee511bcd9f1376e9995ab3f30f6415ad60b7c05 (patch) | |
| tree | e5e64bceeb7082297346411bbee492895e96dc92 /src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc | |
| parent | f9877da406ad96d82becb15b6eef9b723b8807e3 (diff) | |
Doc: Fix qdoc warnings
The warnings were about:
- Undocumented function parameters
- Instances of \instantiates that us an internal class
- A few link issues
Task-number: QTBUG-79827
Change-Id: I60094279c7da6bc446b5c63b7b4924b71cee4672
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc')
| -rw-r--r-- | src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc index 75e59f42..ddf41771 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc @@ -70,15 +70,15 @@ \section1 Using Styles in Qt Quick Controls In order to run an application with a specific style, either configure the - style using \l QQuickStyle in C++, pass a command line argument, or set an + style using \l[CPP]{QQuickStyle} in C++, pass a command line argument, or set an environment variable. Alternatively, the preferred style and style-specific attributes can be specified in a configuration file. The priority of these approaches follows the order they are listed below, - from highest to lowest. That is, using QQuickStyle to set the style will + from highest to lowest. That is, using \c QQuickStyle to set the style will always take priority over using the command line argument, for example. - \warning When resolving a given style name to an absolute path, QQuickStyle + \warning When resolving a given style name to an absolute path, \c QQuickStyle may search the root resource directory (\c {:}). Consequently, make sure that your resource directories are named differently than the names of the styles that your application supports. Otherwise, the styles may not load. @@ -87,14 +87,16 @@ \section2 Using QQuickStyle in C++ - \l QQuickStyle provides C++ API for configuring a specific style. The following - example runs a Qt Quick Controls application with the Material style: + \l[CPP]{QQuickStyle} provides C++ API for configuring a specific + style. The following example runs a Qt Quick Controls application + with the Material style: \code QQuickStyle::setStyle("Material"); \endcode - See the detailed description of \l QQuickStyle for more details. + See the detailed description of \l[CPP]{QQuickStyle} for more + details. \section2 Command line argument |