Document Material.Shade and the related parameter of Material.color()

Change-Id: Id6c4e2051587129d5f76d000be5786bb560efa3f
Task-number: QTBUG-54269
Reviewed-by: J-P Nurmi <jpnurmi@qt.io>

2 files changed, 57 insertions, 4 deletions

diff --git a/src/imports/controls/doc/qtquickcontrols2.qdocconf b/src/imports/controls/doc/qtquickcontrols2.qdocconf
index f61fc77d..bec995d3 100644
--- a/src/imports/controls/doc/qtquickcontrols2.qdocconf
+++ b/src/imports/controls/doc/qtquickcontrols2.qdocconf
@@ -79,6 +79,14 @@ macro.endstyleproperty = "\\br"
 macro.stylemethod.HTML = "<div class=\"qmlproto\"><table class=\"qmlname\"><tbody><tr valign=\"top\" class=\"odd\" id=\"\5\"><td class=\"tblQmlFuncNode\"><p><span class=\"type\">\1</span> <span class=\"name\">\2</span>(<span class="type">\3</span> <i>\4</i>)</p></td></tr></tbody></table></div>"
 macro.endstylemethod = "\\br"
 
+# \stylemethod2 {returntype} {methodname} {arg1type} {arg1name} {arg2type} {arg2name} {html-target-id}
+# \target html-target-id
+# This method returns ...
+# (empty line)
+# \endstylemethod2
+macro.stylemethod2.HTML = "<div class=\"qmlproto\"><table class=\"qmlname\"><tbody><tr valign=\"top\" class=\"odd\" id=\"\7\"><td class=\"tblQmlFuncNode\"><p><span class=\"type\">\1</span> <span class=\"name\">\2</span>(<span class="type">\3</span> <i>\4</i>, <span class="type">\5</span> <i>\6</i>)</p></td></tr></tbody></table></div>"
+macro.endstylemethod2 = "\\br"
+
 # \stylecolor {#6A00FF} {(default)}
 macro.stylecolor.HTML = "<div style=\"padding:10px;color:#fff;background:\1;\">\1 \2</div>"
 
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
index 7cdcf354..986dae65 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
@@ -47,7 +47,7 @@
     \section1 Attached Methods
 
     \list
-        \li color \l {color-attached-method}{\b color}(enumeration predefined)
+        \li color \l {color-attached-method}{\b color}(enumeration predefined, enumeration shade)
     \endlist
 
     \section1 Detailed Description
@@ -209,6 +209,50 @@
     \value Material.Grey \stylecolor {#9E9E9E} {}
     \value Material.BlueGrey \stylecolor {#607D8B} {}
 
+    When the dark theme is in use, different \l {Pre-defined Shades}{shades} of
+    the pre-defined colors are used by default:
+
+    \value Material.Red \stylecolor {#EF9A9A} {}
+    \value Material.Pink \stylecolor {#F48FB1} {(default accent)}
+    \value Material.Purple \stylecolor {#CE93D8} {}
+    \value Material.DeepPurple \stylecolor {#B39DDB} {}
+    \value Material.Indigo \stylecolor {#9FA8DA} {(default primary)}
+    \value Material.Blue \stylecolor {#90CAF9} {}
+    \value Material.LightBlue \stylecolor {#81D4FA} {}
+    \value Material.Cyan \stylecolor {#80DEEA} {}
+    \value Material.Teal \stylecolor {#80CBC4} {}
+    \value Material.Green \stylecolor {#A5D6A7} {}
+    \value Material.LightGreen \stylecolor {#C5E1A5} {}
+    \value Material.Lime \stylecolor {#E6EE9C} {}
+    \value Material.Yellow \stylecolor {#FFF59D} {}
+    \value Material.Amber \stylecolor {#FFE082} {}
+    \value Material.Orange \stylecolor {#FFCC80} {}
+    \value Material.DeepOrange \stylecolor {#FFAB91} {}
+    \value Material.Brown \stylecolor {#BCAAA4} {}
+    \value Material.Grey \stylecolor {#EEEEEE} {}
+    \value Material.BlueGrey \stylecolor {#B0BEC5} {}
+
+    \section2 Pre-defined Shades
+
+    There are several different
+    \l {https://material.google.com/style/color.html#color-color-palette}{shades}
+    of each \l {Pre-defined Colors}{pre-defined color} that can be passed to the
+    \l {color-attached-method}{Material.color()} function:
+    \value Material.Shade50
+    \value Material.Shade100
+    \value Material.Shade200
+    \value Material.Shade300
+    \value Material.Shade400
+    \value Material.Shade500
+    \value Material.Shade600
+    \value Material.Shade700
+    \value Material.Shade800
+    \value Material.Shade900
+    \value Material.ShadeA100
+    \value Material.ShadeA200
+    \value Material.ShadeA400
+    \value Material.ShadeA700
+
     \b {See also} \l {Default Style}, \l {Universal Style}
 
     \section1 Attached Property Documentation
@@ -270,10 +314,11 @@
 
     \section1 Attached Method Documentation
 
-    \stylemethod {color} {color} {enumeration} {predefined} {color-attached-method}
+    \stylemethod2 {color} {color} {enumeration} {predefined} {enumeration} {shade} {color-attached-method}
     \target color-attached-method
     This attached method returns the color value of the specified \l {pre-defined colors}
-    {pre-defined color}.
+    {pre-defined color} combined with the given \l {pre-defined colors}{shade}.
+    If omitted, the shade argument defaults to \c Material.Shade500.
 
     \qml
     import QtQuick 2.0
@@ -284,7 +329,7 @@
     }
     \endqml
 
-    \endstylemethod
+    \endstylemethod2
 
     \section1 Related Information