on xenial help sign in
Fix documentation style.
c8146ffMichał Sawicz
qml/Dash/CardTool.qml+22−13
@@ -16,21 +16,26 @@
16
16
17import QtQuick 2.0
17import QtQuick 2.0
18
18
19+/*!
19−/*! \brief Tool for introspecting Card properties.
20+ \brief Tool for introspecting Card properties.
20
21
21− Some properties of Cards we need to determine category-wide (like card sizes in grid),
22+ Some properties of Cards we need to determine category-wide (like card sizes in grid),
22− so we should not do them per-Card but in the category renderer.
23+ so we should not do them per-Card but in the category renderer.
23
24
24− This component creates an invisible card filled with maximum mapped data and calculates
25+ This component creates an invisible card filled with maximum mapped data and calculates
25− or measures card properties for this configuration.
26+ or measures card properties for this configuration.
26 */
27 */
27
28
28Item {
29Item {
29 id: cardTool
30 id: cardTool
31+ /*!
30− /// Template supplied for the category.
32+ Template supplied for the category.
33+ */
31 property var template
34 property var template
32
35
36+ /*!
33− /// Component mapping supplied for the category.
37+ Component mapping supplied for the category.
38+ */
34 property var components
39 property var components
35
40
36 // FIXME: Saviq
41 // FIXME: Saviq
@@ -40,9 +45,11 @@ Item {
40 height: 0
45 height: 0
41 clip: true
46 clip: true
42
47
48+ /*!
43− /// type:real \brief Width to be enforced on the card in this configuration.
49+ type:real \brief Width to be enforced on the card in this configuration.
44− ///
50+
45− /// If undefined, should use implicit width of the actual card.
51+ If undefined, should use implicit width of the actual card.
52+ */
46 property var cardWidth: {
53 property var cardWidth: {
47 switch (template !== undefined && template["category-layout"]) {
54 switch (template !== undefined && template["category-layout"]) {
48 case "grid":
55 case "grid":
@@ -61,9 +68,11 @@ Item {
61 }
68 }
62 }
69 }
63
70
71+ /*!
64− /// type:real \brief Height to be enforced on the card in this configuration.
72+ type:real \brief Height to be enforced on the card in this configuration.
65− ///
73+
66− /// If undefined, should use implicit height of the actual card.
74+ If undefined, should use implicit height of the actual card.
75+ */
67 property var cardHeight: {
76 property var cardHeight: {
68 switch (template !== undefined && template["category-layout"]) {
77 switch (template !== undefined && template["category-layout"]) {
69 case "journal":
78 case "journal":