From bf6409b3a882dc3526c8723b916785149a862017 Mon Sep 17 00:00:00 2001
From: Uwe Rathmann <Uwe.Rathmann@tigertal.de>
Date: Wed, 17 Feb 2021 11:09:45 +0100
Subject: [PATCH] doxygen docs

---
 doc/classes/QskSkinnable.dox | 68 ++++++++++++++++++++++++++++++++++++
 src/controls/QskSkinnable.h  |  9 ++---
 2 files changed, 73 insertions(+), 4 deletions(-)

diff --git a/doc/classes/QskSkinnable.dox b/doc/classes/QskSkinnable.dox
index a144bbad..41af8c28 100644
--- a/doc/classes/QskSkinnable.dox
+++ b/doc/classes/QskSkinnable.dox
@@ -275,33 +275,101 @@
 */
 
 /*! \fn QskSkinnable::debug( QskAspect ) const
+
+	Writes an aspect to qDebug() using the string conversions for metaObject()
+
+	\param aspect Aspect to be printed
+	\sa qskDebugAspect()
 */
 
 /*! \fn QskSkinnable::debug( QskAspect::State ) const
+
+	Writes a state to qDebug() using the string conversions for metaObject()
+    
+    \param state State to be printed
+    \sa qskDebugState()
 */
 
 /*! \fn QskSkinnable::debug( QDebug, QskAspect ) const
+
+    Writes an aspect to a stream using the string conversions for metaObject()
+    
+    \param debug Debug stream
+    \param aspect Aspect to be printed
+
+    \sa qskDebugAspect()
 */
 
 /*! \fn QskSkinnable::debug( QDebug, QskAspect::State ) const
+
+    Writes a state to a stream using the string conversions for metaObject()
+    
+    \param debug Debug stream
+    \param state State to be printed
+
+    \sa qskDebugState()
 */
 
 /*! \fn QskSkinnable::setSkinState
+
+	Set the state bits of the skinnable
+
+	Depending on the state a skinnable might have different hints affecting
+    its representation and/or behaviour.
+
+	\param newState State bits
+	\param animated If true, animators, that have been defined in the skin
+                    for newState will be started
+
+	\sa QskAspect
 */
 
 /*! \fn QskSkinnable::setSkinStateFlag
+
+	Set/Clear a state in the state bits 
+
+	\param stateFlag State bit
+	\param on true or false
+
+	\sa setSkinState(), skinState()
 */
 
 /*! \fn QskSkinnable::setColor( QskAspect, Qt::GlobalColor )
+
+	\code setSkinHint( aspect | QskAspect::Color, QVariant::fromValue( QColor( color ) ) ); \endcode
+
+	\param aspect Unresolved aspect
+	\param color Color hint
+
+	\sa setSkinHint()
 */
 
 /*! \fn QskSkinnable::setColor( QskAspect, QRgb )
+
+	\code setSkinHint( aspect | QskAspect::Color, QVariant::fromValue( QColor::fromRgba( rgb ) ) ); \endcode
+
+	\param aspect Unresolved aspect
+	\param rgb Color hint
 */
 
 /*! \fn QskSkinnable::setColor( QskAspect, const QColor& )
+
+	\code setSkinHint( aspect | QskAspect::Color, QVariant::fromValue( color ) ); \endcode
+
+	\param aspect Unresolved aspect
+	\param color Color hint
+
+	\sa setSkinHint()
 */
 
 /*! \fn QskSkinnable::resetColor
+
+	\code return resetSkinHint( aspect | QskAspect::Color ); \endcode
+
+	\param aspect Unresolved aspect
+	\return true, if an entry in the local hint table was found and removed.
+
+	\sa resetSkinHint()
 */
 
 /*! \fn QskSkinnable::color
diff --git a/src/controls/QskSkinnable.h b/src/controls/QskSkinnable.h
index e17d7f3e..03b6f85c 100644
--- a/src/controls/QskSkinnable.h
+++ b/src/controls/QskSkinnable.h
@@ -93,10 +93,6 @@ class QSK_EXPORT QskSkinnable
 
     QskSkinHintStatus hintStatus( QskAspect ) const;
 
-    QskAspect::State skinState() const;
-    const char* skinStateAsPrintable() const;
-    const char* skinStateAsPrintable( QskAspect::State ) const;
-
     QRectF subControlRect( const QRectF&, QskAspect::Subcontrol ) const;
     QRectF subControlContentsRect( const QRectF&, QskAspect::Subcontrol ) const;
 
@@ -130,6 +126,11 @@ class QSK_EXPORT QskSkinnable
     void setSkinState( QskAspect::State, bool animated = true );
     void setSkinStateFlag( QskAspect::State, bool on = true );
 
+    QskAspect::State skinState() const;
+
+    const char* skinStateAsPrintable() const;
+    const char* skinStateAsPrintable( QskAspect::State ) const;
+
     // type aware methods for accessing skin hints
 
     bool setColor( QskAspect, Qt::GlobalColor );