docs: convert from qdoc to Doxygen

Issue: #345
lirios · Nov 2, 2024 · 53e9437 · 53e9437
1 parent 866ff55
commit 53e9437
Show file tree

Hide file tree

Showing 19 changed files with 171 additions and 406 deletions.
diff --git a/src/imports/controls/qml/AutomaticGrid.qml b/src/imports/controls/qml/AutomaticGrid.qml
@@ -16,13 +16,9 @@
 import QtQuick
 
 /*!
-    \qmltype AutomaticGrid
-    \inqmlmodule Fluid
-    \ingroup fluid
-
     \brief Lay out children in a grid that automatically fits the available space.
 
-    \code
+    \code{.qml}
     import QtQuick
     import Fluid as Fluid
 
@@ -52,32 +48,23 @@ Grid {
     id: grid
 
     /*!
-        \qmlproperty Component delegate
-        \default
-
         The delegate provides a template defining each item istantiated by the grid.
 
         \sa Repeater::delegate
     */
     default property alias delegate: repeater.delegate
 
     /*!
-        \qmlproperty real cellWidth
-
         Cell width.
     */
     property real cellWidth
 
     /*!
-        \qmlproperty real cellHeight
-
         Cell height.
     */
     property real cellHeight
 
     /*!
-        \qmlproperty any model
-
         The model providing data to the grid.
 
         This property can be set to any of the supported \l {qml-data-models}{data models}.
@@ -87,22 +74,16 @@ Grid {
     property alias model: repeater.model
 
     /*!
-        \qmlproperty real widthOverride
-
         Maximum width.
     */
     property real widthOverride: parent.width
 
     /*!
-        \qmlproperty real heightOverride
-
         Maximum height.
     */
     property real heightOverride: parent.height
 
     /*!
-        \qmlproperty real minColumnSpacing
-
         Minimum spacing between columns.
     */
     property real minColumnSpacing

diff --git a/src/imports/controls/qml/BoxShadow.qml b/src/imports/controls/qml/BoxShadow.qml
@@ -16,62 +16,44 @@ import QtQuick
 import Qt5Compat.GraphicalEffects
 
 /*!
-  \qmltype BoxShadow
-  \inqmlmodule Fluid
-  \ingroup fluid
-
   \brief A implementation of CSS's box-shadow.
 
   A implementation of CSS's box-shadow, used by Elevation for a Material Design
   elevation shadow effect.
 */
 RectangularGlow {
     /*!
-        \qmlproperty int offsetX
-
         Position of the horizontal shadow.
     */
     property int offsetX
 
     /*!
-        \qmlproperty int offsetY
-
         Position of the vertical shadow.
     */
     property int offsetY
 
     /*!
-        \qmlproperty int blurRadius
-
         Blur distance.
     */
     property int blurRadius
 
     /*!
-        \qmlproperty int spreadRadius
-
         Size of shadow.
     */
     property int spreadRadius
 
     /*!
-        \qmlproperty Item source
-
         The source item the shadow is being applied to, used for correctly
         calculating the corner radius.
     */
     property Item source
 
     /*!
-        \qmlproperty bool fullWidth
-
         Whether the shadow width is calculated based on the parent width.
     */
     property bool fullWidth
 
     /*!
-        \qmlproperty bool fullHeight
-
         Whether the shadow height is calculated based on the parent height.
     */
     property bool fullHeight

diff --git a/src/imports/controls/qml/CircleMask.qml b/src/imports/controls/qml/CircleMask.qml
@@ -17,18 +17,12 @@ import QtQuick
 import Qt5Compat.GraphicalEffects
 
 /*!
-  \qmltype CircleMask
-  \inqmlmodule Fluid
-  \ingroup fluid
-
-  \brief Circular mask.
+    \brief Circular mask.
 */
 Item {
     id: item
 
     /*!
-        \qmlproperty variant source
-
         This property defines the source item that is going to be masked.
     */
     property alias source: mask.source

diff --git a/src/imports/controls/qml/ColumnFlow.qml b/src/imports/controls/qml/ColumnFlow.qml
@@ -16,13 +16,9 @@
 import QtQuick
 
 /*!
-    \qmltype ColumnFlow
-    \inqmlmodule Fluid
-    \ingroup fluid
-
     \brief Automatically position children in columns.
 
-    \code
+    \code{.qml}
     import QtQuick
     import Fluid as Fluid
 
@@ -51,24 +47,18 @@ Item {
     id: columnFlow
 
     /*!
-        \qmlproperty int columnWidth
-
         Column width.
         This property is \c 100 by default.
     */
     property int columnWidth: 100
 
     /*!
-        \qmlproperty int columns
-
         Number of columns.
         By default it fits as many columns as possible.
     */
     property int columns: Math.max(0, Math.floor(width / columnWidth))
 
     /*!
-        \qmlproperty any model
-
         The model providing data to the column flow.
 
         This property can be set to any of the supported \l {qml-data-models}{data models}.
@@ -78,24 +68,18 @@ Item {
     property alias model: repeater.model
 
     /*!
-        \qmlproperty Component delegate
-
         The delegate provides a template defining each item istantiated by the column flow.
 
         \sa Repeater::delegate
     */
     property alias delegate: repeater.delegate
 
     /*!
-        \qmlproperty int contentHeight
-
         Content height.
     */
     property int contentHeight: 0
 
     /*!
-        \qmlproperty bool repeaterCompleted
-
         This property holds whether the layout is done.
     */
     readonly property alias repeaterCompleted: __private.repeaterCompleted
@@ -114,8 +98,6 @@ Item {
     }
 
     /*!
-        \qmlmethod void ColumnFlow::updateWidths()
-
         Set the width of all delegates.
     */
     function updateWidths() {
@@ -134,8 +116,6 @@ Item {
     }
 
     /*!
-        \qmlmethod void ColumnFlow::reEvalColumns()
-
         Relayout the columns.
     */
     function reEvalColumns() {

diff --git a/src/imports/controls/qml/DatePickerDialog.qml b/src/imports/controls/qml/DatePickerDialog.qml
@@ -18,10 +18,6 @@ import QtQuick.Controls.Material
 import Fluid as Fluid
 
 /*!
-    \qmltype DatePickerDialog
-    \inqmlmodule Fluid
-    \ingroup fluid
-
     \brief Dialog to select a single date.
 
     Dialog to select a single date from a calendar.

diff --git a/src/imports/controls/qml/Elevation.qml b/src/imports/controls/qml/Elevation.qml
@@ -16,10 +16,6 @@ import QtQuick
 import Fluid
 
 /*!
-   \qmltype Elevation
-   \inqmlmodule Fluid
-   \ingroup fluid
-
    \brief Material Design elevation effect.
 
    An effect for standard Material Design elevation shadows.

diff --git a/src/imports/controls/qml/FloatingActionButton.qml b/src/imports/controls/qml/FloatingActionButton.qml
@@ -20,10 +20,6 @@ import Qt5Compat.GraphicalEffects
 import Fluid as Fluid
 
 /*!
-    \qmltype FloatingActionButton
-    \inqmlmodule Fluid
-    \ingroup fluid
-
     \brief A floating action button.
 
     A floating action button represents the primary action of the current page

diff --git a/src/imports/controls/qml/Object.qml b/src/imports/controls/qml/Object.qml
@@ -15,24 +15,20 @@
 import QtQuick
 
 /*!
-    \qmltype Object
-    \inqmlmodule Fluid
-    \ingroup fluid
-
     \brief A \l QtObject with children.
 
     The \l Object type is a non-visual element that extends \l QtObject
     with the ability to hold children objects.
 
-   \qml
+   \code{.qml}
    import QtQuick
    import Fluid
 
    Object {
        QtObject {}
        QtObject {}
    }
-   \endqml
+   \endcode
 */
 QtObject {
     id: object

diff --git a/src/imports/controls/qml/TabbedPage.qml b/src/imports/controls/qml/TabbedPage.qml
@@ -180,18 +180,14 @@ Fluid.Page {
     }
 
     /*!
-        \qmlmethod void TabbedPage::addTab(Tab tab)
-
         Add a \a tab programmatically to the page.
-     */
+    */
     function addTab(tab) {
         swipeView.addItem(tab);
         swipeView.setCurrentIndex(swipeView.count - 1);
     }
 
     /*!
-        \qmlmethod void TabbedPage::removeTab(int index)
-
         Remove the tab with \a index programmatically.
     */
     function removeTab(index) {
@@ -200,26 +196,20 @@ Fluid.Page {
     }
 
     /*!
-        \qmlmethod Tab TabbedPage::getTab(int index)
-
         Return the tab with \a index.
     */
     function getTab(index) {
         return swipeView.itemAt(index);
     }
 
     /*!
-        \qmlmethod void TabbedPage::setCurrentIndex(int index)
-
         Select the tab that correspond to \a index.
     */
     function setCurrentIndex(index) {
         swipeView.setCurrentIndex(index);
     }
 
     /*!
-        \qmlmethod void TabbedPage::incrementCurrentIndex()
-
         Increment current index.
 
         \sa currentIndex
@@ -229,8 +219,6 @@ Fluid.Page {
     }
 
     /*!
-        \qmlmethod void TabbedPage::decrementCurrentIndex()
-
         Decrement current index.
 
         \sa currentIndex

diff --git a/src/imports/controls/qml/Vignette.qml b/src/imports/controls/qml/Vignette.qml
@@ -15,10 +15,6 @@
 import QtQuick
 
 /*!
-  \qmltype Vignette
-  \inqmlmodule Fluid
-  \ingroup fluid
-
   \brief Vignette effect.
 */
 Item {

diff --git a/src/imports/templates/Card.qml b/src/imports/templates/Card.qml
@@ -16,14 +16,10 @@ import QtQuick.Controls as C
 import QtQuick.Controls.Material
 
 /*!
-    \qmltype Fluid.Templates.Card
-    \inqmlmodule Fluid.Templates
-    \ingroup fluidtemplates
-
     \brief Cards display content composed of different elements.
 
     For more information you can read the
-    \l{https://material.io/guidelines/components/cards.html}{Material Design guidelines}.
+    <a href="https://material.io/guidelines/components/cards.html">Material Design guidelines</a>.
 */
 C.Pane {
     padding: 0