aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@qt.io>2016-08-13 14:12:19 +0200
committerJ-P Nurmi <jpnurmi@qt.io>2016-08-13 21:28:54 +0000
commite479bd241a5263b0ddfb4fad725dd26f34d5e39a (patch)
treed46965da9d96f3063ff81449b5dea0974117974c /src/imports/controls
parent3887055f7fbaf1f931253f84d0bbb531db5efaf6 (diff)
Doc: fix qdoc warnings in the Material style internals
Don't use qdoc syntax for the internals that are not supposed to be in the docs. Change-Id: I2abd61e50b89ed5c800364ce5732f85dda9d54b9 Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
Diffstat (limited to 'src/imports/controls')
-rw-r--r--src/imports/controls/material/BoxShadow.qml2
-rw-r--r--src/imports/controls/material/ElevationEffect.qml16
-rw-r--r--src/imports/controls/material/RectangularGlow.qml12
3 files changed, 15 insertions, 15 deletions
diff --git a/src/imports/controls/material/BoxShadow.qml b/src/imports/controls/material/BoxShadow.qml
index 43722b73..02950a60 100644
--- a/src/imports/controls/material/BoxShadow.qml
+++ b/src/imports/controls/material/BoxShadow.qml
@@ -38,7 +38,7 @@ import QtQuick 2.6
import QtQuick.Controls.Material 2.1
import QtQuick.Controls.Material.impl 2.1
-/*!
+/*
A implementation of CSS's box-shadow, used by ElevationEffect for a Material Design
elevation shadow effect.
*/
diff --git a/src/imports/controls/material/ElevationEffect.qml b/src/imports/controls/material/ElevationEffect.qml
index 7038f472..00d7b997 100644
--- a/src/imports/controls/material/ElevationEffect.qml
+++ b/src/imports/controls/material/ElevationEffect.qml
@@ -38,23 +38,23 @@ import QtQuick 2.6
import QtQuick.Controls.Material 2.1
import QtQuick.Controls.Material.impl 2.1
-/*!
+/*
An effect for standard Material Design elevation shadows. Useful for using as \c layer.effect.
*/
Item {
id: effect
- /*!
+ /*
The source the effect is applied to.
*/
property var source
- /*!
+ /*
The elevation of the \l source Item.
*/
property int elevation: 0
- /*!
+ /*
Set to \c true if the \l source Item is the same width as its parent and the shadow
should be full width instead of rounding around the corner of the Item.
@@ -62,7 +62,7 @@ Item {
*/
property bool fullWidth: false
- /*!
+ /*
Set to \c true if the \l source Item is the same height as its parent and the shadow
should be full height instead of rounding around the corner of the Item.
@@ -70,7 +70,7 @@ Item {
*/
property bool fullHeight: false
- /*!
+ /*
\internal
The actual source Item the effect is applied to.
@@ -102,7 +102,7 @@ Item {
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
- /*!
+ /*
\internal
The shadows to use for each possible elevation. There are three shadows that when combined
@@ -210,7 +210,7 @@ Item {
{offset: 9, blur: 46, spread: 8}]
]
- /*!
+ /*
\internal
The current shadow based on the elevation.
diff --git a/src/imports/controls/material/RectangularGlow.qml b/src/imports/controls/material/RectangularGlow.qml
index 7cec7e54..32c10500 100644
--- a/src/imports/controls/material/RectangularGlow.qml
+++ b/src/imports/controls/material/RectangularGlow.qml
@@ -36,13 +36,13 @@
import QtQuick 2.0
-/*!
+/*
A cross-graphics API implementation of QtGraphicalEffects' RectangularGlow.
*/
Item {
id: rootItem
- /*!
+ /*
This property defines how many pixels outside the item area are reached
by the glow.
@@ -79,7 +79,7 @@ Item {
*/
property real glowRadius: 0.0
- /*!
+ /*
This property defines how large part of the glow color is strenghtened
near the source edges.
@@ -115,7 +115,7 @@ Item {
*/
property real spread: 0.0
- /*!
+ /*
This property defines the RGBA color value which is used for the glow.
By default, the property is set to \c "white".
@@ -149,7 +149,7 @@ Item {
*/
property color color: "white"
- /*!
+ /*
This property defines the corner radius that is used to draw a glow with
rounded corners.
@@ -190,7 +190,7 @@ Item {
*/
property real cornerRadius: glowRadius
- /*!
+ /*
This property allows the effect output pixels to be cached in order to
improve the rendering performance.