From d0b07cc4650f4d014327edc7b650b719980e9efa Mon Sep 17 00:00:00 2001
From: Uwe Rathmann <Uwe.Rathmann@tigertal.de>
Date: Tue, 14 Dec 2021 08:45:49 +0100
Subject: [PATCH] docs added

---
 doc/classes/QskAspect.dox    |   4 +-
 doc/classes/QskControl.dox   | 108 ++++++++++++++++++++++++++---------
 doc/classes/QskQuickItem.dox |   6 +-
 3 files changed, 85 insertions(+), 33 deletions(-)

diff --git a/doc/classes/QskAspect.dox b/doc/classes/QskAspect.dox
index a6f80bd5..60e3aae3 100644
--- a/doc/classes/QskAspect.dox
+++ b/doc/classes/QskAspect.dox
@@ -4,8 +4,8 @@
 
     \brief Lookup key for a QskSkinHintTable
 
-    QskAspect is used by the \ref qskskinning "themeing system" to determine how
-    a given aspect of a control is drawn. While an aspect is simply a 64-bit
+    QskAspect is used by the \ref qskskinning "themeing system" to determine a
+    a certain aspect of a QskSkinnable. While an aspect is simply a 64-bit
     unsigned integer, it is composed of smaller enum bitfields which can be ORed
     together to describe a more specific part of the user interface.
 
diff --git a/doc/classes/QskControl.dox b/doc/classes/QskControl.dox
index 7c6a4c74..ee72dbc7 100644
--- a/doc/classes/QskControl.dox
+++ b/doc/classes/QskControl.dox
@@ -245,6 +245,22 @@
     \sa contentsRect(), margins(), QskSkinnable::setMarginHint()
 */
 
+/*!
+    \fn QskControl::setMargins( qreal, qreal, qreal, qreal )
+
+    The value is stored in the local hint table for the aspect:
+         QskControl::Control | QskAspect::Metric | QskAspect::Margin
+
+    \param left Left margin
+    \param top Top margin
+    \param right Right margin
+    \param bottom Bottom margin
+
+    \aspect QskControl::Control | QskAspect::Metric | QskAspect::Margin
+
+    \sa contentsRect(), margins(), QskSkinnable::setMarginHint()
+*/
+
 /*!
     \fn QskControl::setMargins( const QMarginsF& )
 
@@ -496,16 +512,25 @@
 /*!
     \fn QskControl::setSizePolicy( QskSizePolicy )
 
+    Set the value for the \ref sizePolicy property
 */
 
 /*!
     \fn QskControl::setSizePolicy( QskSizePolicy::Policy, QskSizePolicy::Policy )
 
+    Set the value for the \ref sizePolicy property
+
+    \param horizontalPolicy Policy for the width
+    \param verticalPolicy Policy for the height
 */
 
 /*!
     \fn QskControl::setSizePolicy( Qt::Orientation, QskSizePolicy::Policy )
 
+    Modifies the value for the \ref sizePolicy property
+
+    \param orientation Specifies which part of the policy should be changed
+    \param policy Policy for height or width
 */
 
 /*!
@@ -524,6 +549,8 @@
 /*!
     \fn QskControl::sizePolicy( Qt::Orientation ) const
 
+    \param orientation Specifies the part of the policy
+    \return Height or width related part of the \ref sizePolicy property
 */
 
 /*!
@@ -806,16 +833,6 @@
 
 */
 
-/*!
-    \fn QskControl::locale() const
-
-*/
-
-/*!
-    \fn QskControl::resetLocale
-
-*/
-
 /*!
     \fn QskControl::subControls
 
@@ -849,26 +866,68 @@
 */
 
 /*!
-    \fn QskControl::localeChanged
+    \fn QskControl::locale() const
 
-*/
-
-/*!
-    \fn QskControl::focusPolicyChanged
-*/
-
-/*!
-    \fn QskControl::wheelEnabledChanged
+    \return Value of the \ref locale property
+    \sa setLocale(), resetLocale(), localeChanged()
+    \saqt QEvent::LocaleChange
 */
 
 /*!
     \fn QskControl::setLocale
+
+    Set the \ref locale for the control and all its descendents, that do not
+    have their own locale
+
+    \sa locale(), resetLocale(), localeChanged()
+    \saqt QEvent::LocaleChange
+*/
+
+/*!
+    \fn QskControl::resetLocale
+
+    Reset the locale to be inherited from the parentItem()
+
+    \sa locale(), setLocale(), localeChanged()
+    \saqt QEvent::LocaleChange
+*/
+
+/*!
+    \fn QskControl::localeChanged
+
+    Signal indicating, that the value of the \ref locale property has changed
+
+    \sa locale
+    \saqt QEvent::LocaleChange
+*/
+
+/*!
+    \fn QskControl::focusPolicyChanged
+
+    Signal indicating, that the value of the \ref focusPolicy property has changed
+    \sa focusPolicy
+*/
+
+/*!
+    \fn QskControl::wheelEnabledChanged
+
+    Signal indicating, that the value of the \ref wheelEnabled property has changed
+    \sa wheelEnabled
 */
 
 /*!
     \fn QskControl::event
 */
 
+/*!
+    \fn QskControl::childMouseEventFilter
+
+*/
+
+/*!
+    \fn QskControl::gestureFilter
+*/
+
 /*!
     \fn void QskControl::gestureEvent
 
@@ -878,21 +937,14 @@
     \fn void QskControl::hoverEnterEvent
 
     Sets the Hovered state
+    \sa QskControl::Hovered, hoverLeaveEvent()
 */
 
 /*!
     \fn void QskControl::hoverLeaveEvent
 
     Clears the Hovered state
-*/
-
-/*!
-    \fn QskControl::childMouseEventFilter
-
-*/
-
-/*!
-    \fn QskControl::gestureFilter
+    \sa QskControl::Hovered, hoverEnterEvent()
 */
 
 /*!
diff --git a/doc/classes/QskQuickItem.dox b/doc/classes/QskQuickItem.dox
index 7550b0c2..b4c4750e 100644
--- a/doc/classes/QskQuickItem.dox
+++ b/doc/classes/QskQuickItem.dox
@@ -256,8 +256,8 @@
 
     Set the position and the size of an item
 
-	\param pos Position relative to the parent item
-	\param size Size of the item
+    \param pos Position relative to the parent item
+    \param size Size of the item
 */
 
 /*!
@@ -297,7 +297,7 @@
 /*!
     \fn QskQuickItem::implicitSize
 
-    Qt/Quick offers an oversimplified layout system of Qt/Quick that is based on the
+    Qt/Quick offers an oversimplified layout system that is based on the
     property bindings of implicit width and height. QSkinny restablishs a layout
     system that can compete with what is available in the Qt/Widgets or Qt/Graphics
     technologies.