Skip to content

Commit 53e9437

Browse files
plfioriniplfiorini
committed
docs: convert from qdoc to Doxygen
Issue: #345
1 parent 866ff55 commit 53e9437

19 files changed

+171
-406
lines changed

‎src/imports/controls/qml/AutomaticGrid.qml

+1-20
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,9 @@
1616
import QtQuick
1717

1818
/*!
19-
\qmltype AutomaticGrid
20-
\inqmlmodule Fluid
21-
\ingroup fluid
22-
2319
\brief Lay out children in a grid that automatically fits the available space.
2420
25-
\code
21+
\code{.qml}
2622
import QtQuick
2723
import Fluid as Fluid
2824
@@ -52,32 +48,23 @@ Grid {
5248
id: grid
5349

5450
/*!
55-
\qmlproperty Component delegate
56-
\default
57-
5851
The delegate provides a template defining each item istantiated by the grid.
5952
6053
\sa Repeater::delegate
6154
*/
6255
default property alias delegate: repeater.delegate
6356

6457
/*!
65-
\qmlproperty real cellWidth
66-
6758
Cell width.
6859
*/
6960
property real cellWidth
7061

7162
/*!
72-
\qmlproperty real cellHeight
73-
7463
Cell height.
7564
*/
7665
property real cellHeight
7766

7867
/*!
79-
\qmlproperty any model
80-
8168
The model providing data to the grid.
8269
8370
This property can be set to any of the supported \l {qml-data-models}{data models}.
@@ -87,22 +74,16 @@ Grid {
8774
property alias model: repeater.model
8875

8976
/*!
90-
\qmlproperty real widthOverride
91-
9277
Maximum width.
9378
*/
9479
property real widthOverride: parent.width
9580

9681
/*!
97-
\qmlproperty real heightOverride
98-
9982
Maximum height.
10083
*/
10184
property real heightOverride: parent.height
10285

10386
/*!
104-
\qmlproperty real minColumnSpacing
105-
10687
Minimum spacing between columns.
10788
*/
10889
property real minColumnSpacing

‎src/imports/controls/qml/BoxShadow.qml

-18
Original file line numberDiff line numberDiff line change
@@ -16,62 +16,44 @@ import QtQuick
1616
import Qt5Compat.GraphicalEffects
1717

1818
/*!
19-
\qmltype BoxShadow
20-
\inqmlmodule Fluid
21-
\ingroup fluid
22-
2319
\brief A implementation of CSS's box-shadow.
2420
2521
A implementation of CSS's box-shadow, used by Elevation for a Material Design
2622
elevation shadow effect.
2723
*/
2824
RectangularGlow {
2925
/*!
30-
\qmlproperty int offsetX
31-
3226
Position of the horizontal shadow.
3327
*/
3428
property int offsetX
3529

3630
/*!
37-
\qmlproperty int offsetY
38-
3931
Position of the vertical shadow.
4032
*/
4133
property int offsetY
4234

4335
/*!
44-
\qmlproperty int blurRadius
45-
4636
Blur distance.
4737
*/
4838
property int blurRadius
4939

5040
/*!
51-
\qmlproperty int spreadRadius
52-
5341
Size of shadow.
5442
*/
5543
property int spreadRadius
5644

5745
/*!
58-
\qmlproperty Item source
59-
6046
The source item the shadow is being applied to, used for correctly
6147
calculating the corner radius.
6248
*/
6349
property Item source
6450

6551
/*!
66-
\qmlproperty bool fullWidth
67-
6852
Whether the shadow width is calculated based on the parent width.
6953
*/
7054
property bool fullWidth
7155

7256
/*!
73-
\qmlproperty bool fullHeight
74-
7557
Whether the shadow height is calculated based on the parent height.
7658
*/
7759
property bool fullHeight

‎src/imports/controls/qml/CircleMask.qml

+1-7
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,12 @@ import QtQuick
1717
import Qt5Compat.GraphicalEffects
1818

1919
/*!
20-
\qmltype CircleMask
21-
\inqmlmodule Fluid
22-
\ingroup fluid
23-
24-
\brief Circular mask.
20+
\brief Circular mask.
2521
*/
2622
Item {
2723
id: item
2824

2925
/*!
30-
\qmlproperty variant source
31-
3226
This property defines the source item that is going to be masked.
3327
*/
3428
property alias source: mask.source

‎src/imports/controls/qml/ColumnFlow.qml

+1-21
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,9 @@
1616
import QtQuick
1717

1818
/*!
19-
\qmltype ColumnFlow
20-
\inqmlmodule Fluid
21-
\ingroup fluid
22-
2319
\brief Automatically position children in columns.
2420
25-
\code
21+
\code{.qml}
2622
import QtQuick
2723
import Fluid as Fluid
2824
@@ -51,24 +47,18 @@ Item {
5147
id: columnFlow
5248

5349
/*!
54-
\qmlproperty int columnWidth
55-
5650
Column width.
5751
This property is \c 100 by default.
5852
*/
5953
property int columnWidth: 100
6054

6155
/*!
62-
\qmlproperty int columns
63-
6456
Number of columns.
6557
By default it fits as many columns as possible.
6658
*/
6759
property int columns: Math.max(0, Math.floor(width / columnWidth))
6860

6961
/*!
70-
\qmlproperty any model
71-
7262
The model providing data to the column flow.
7363
7464
This property can be set to any of the supported \l {qml-data-models}{data models}.
@@ -78,24 +68,18 @@ Item {
7868
property alias model: repeater.model
7969

8070
/*!
81-
\qmlproperty Component delegate
82-
8371
The delegate provides a template defining each item istantiated by the column flow.
8472
8573
\sa Repeater::delegate
8674
*/
8775
property alias delegate: repeater.delegate
8876

8977
/*!
90-
\qmlproperty int contentHeight
91-
9278
Content height.
9379
*/
9480
property int contentHeight: 0
9581

9682
/*!
97-
\qmlproperty bool repeaterCompleted
98-
9983
This property holds whether the layout is done.
10084
*/
10185
readonly property alias repeaterCompleted: __private.repeaterCompleted
@@ -114,8 +98,6 @@ Item {
11498
}
11599

116100
/*!
117-
\qmlmethod void ColumnFlow::updateWidths()
118-
119101
Set the width of all delegates.
120102
*/
121103
function updateWidths() {
@@ -134,8 +116,6 @@ Item {
134116
}
135117

136118
/*!
137-
\qmlmethod void ColumnFlow::reEvalColumns()
138-
139119
Relayout the columns.
140120
*/
141121
function reEvalColumns() {

‎src/imports/controls/qml/DatePickerDialog.qml

-4
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ import QtQuick.Controls.Material
1818
import Fluid as Fluid
1919

2020
/*!
21-
\qmltype DatePickerDialog
22-
\inqmlmodule Fluid
23-
\ingroup fluid
24-
2521
\brief Dialog to select a single date.
2622
2723
Dialog to select a single date from a calendar.

‎src/imports/controls/qml/Elevation.qml

-4
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ import QtQuick
1616
import Fluid
1717

1818
/*!
19-
\qmltype Elevation
20-
\inqmlmodule Fluid
21-
\ingroup fluid
22-
2319
\brief Material Design elevation effect.
2420
2521
An effect for standard Material Design elevation shadows.

‎src/imports/controls/qml/FloatingActionButton.qml

-4
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,6 @@ import Qt5Compat.GraphicalEffects
2020
import Fluid as Fluid
2121

2222
/*!
23-
\qmltype FloatingActionButton
24-
\inqmlmodule Fluid
25-
\ingroup fluid
26-
2723
\brief A floating action button.
2824
2925
A floating action button represents the primary action of the current page

‎src/imports/controls/qml/Object.qml

+2-6
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,20 @@
1515
import QtQuick
1616

1717
/*!
18-
\qmltype Object
19-
\inqmlmodule Fluid
20-
\ingroup fluid
21-
2218
\brief A \l QtObject with children.
2319
2420
The \l Object type is a non-visual element that extends \l QtObject
2521
with the ability to hold children objects.
2622
27-
\qml
23+
\code{.qml}
2824
import QtQuick
2925
import Fluid
3026
3127
Object {
3228
QtObject {}
3329
QtObject {}
3430
}
35-
\endqml
31+
\endcode
3632
*/
3733
QtObject {
3834
id: object

‎src/imports/controls/qml/TabbedPage.qml

+1-13
Original file line numberDiff line numberDiff line change
@@ -180,18 +180,14 @@ Fluid.Page {
180180
}
181181

182182
/*!
183-
\qmlmethod void TabbedPage::addTab(Tab tab)
184-
185183
Add a \a tab programmatically to the page.
186-
*/
184+
*/
187185
function addTab(tab) {
188186
swipeView.addItem(tab);
189187
swipeView.setCurrentIndex(swipeView.count - 1);
190188
}
191189

192190
/*!
193-
\qmlmethod void TabbedPage::removeTab(int index)
194-
195191
Remove the tab with \a index programmatically.
196192
*/
197193
function removeTab(index) {
@@ -200,26 +196,20 @@ Fluid.Page {
200196
}
201197

202198
/*!
203-
\qmlmethod Tab TabbedPage::getTab(int index)
204-
205199
Return the tab with \a index.
206200
*/
207201
function getTab(index) {
208202
return swipeView.itemAt(index);
209203
}
210204

211205
/*!
212-
\qmlmethod void TabbedPage::setCurrentIndex(int index)
213-
214206
Select the tab that correspond to \a index.
215207
*/
216208
function setCurrentIndex(index) {
217209
swipeView.setCurrentIndex(index);
218210
}
219211

220212
/*!
221-
\qmlmethod void TabbedPage::incrementCurrentIndex()
222-
223213
Increment current index.
224214
225215
\sa currentIndex
@@ -229,8 +219,6 @@ Fluid.Page {
229219
}
230220

231221
/*!
232-
\qmlmethod void TabbedPage::decrementCurrentIndex()
233-
234222
Decrement current index.
235223
236224
\sa currentIndex

‎src/imports/controls/qml/Vignette.qml

-4
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,6 @@
1515
import QtQuick
1616

1717
/*!
18-
\qmltype Vignette
19-
\inqmlmodule Fluid
20-
\ingroup fluid
21-
2218
\brief Vignette effect.
2319
*/
2420
Item {

‎src/imports/templates/Card.qml

+1-5
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,10 @@ import QtQuick.Controls as C
1616
import QtQuick.Controls.Material
1717

1818
/*!
19-
\qmltype Fluid.Templates.Card
20-
\inqmlmodule Fluid.Templates
21-
\ingroup fluidtemplates
22-
2319
\brief Cards display content composed of different elements.
2420
2521
For more information you can read the
26-
\l{https://material.io/guidelines/components/cards.html}{Material Design guidelines}.
22+
<a href="https://material.io/guidelines/components/cards.html">Material Design guidelines</a>.
2723
*/
2824
C.Pane {
2925
padding: 0

0 commit comments

Comments
 (0)