doxygen texts

doc/classes/QskNamespace.dox

@@ -0,0 +1,37 @@
+/*!
+    \namespace Qsk
+
+    \ingroup Framework
+
+    \brief Global definitions
+*/
+
+/*!
+    \enum Qsk::Direction
+
+    \brief This enum type specifies a horizontal ot vertical direction
+
+    \var Qsk::LeftToRight
+         Horizontally from left to right
+
+    \var Qsk::RightToLeft
+         Horizontally from right to left
+
+    \var Qsk::TopToBottom
+         Vertically from top to bottom
+
+    \var Qsk::BottomToTop
+         Vertically from bottom to top
+*/
+
+/*!
+    \enum Qsk::Visibility
+
+    \brief Visibility of an object
+
+    \var Qsk::Visible
+        The object is visible
+
+    \var Qsk::Hidden
+        The object is not visible
+*/

doc/classes/QskPlacementPolicy.dox

@@ -3,8 +3,8 @@
 
     \ingroup Framework
 
-	QskPlacementPolicy is a hint for layout code how to deal with
+    QskPlacementPolicy is a hint for layout code how to deal with
-	the geometry of an item when being visible or hidden.
+    the geometry of an item depending on its visibility.
 
     \sa QskControl::placementPolicy(), qskPlacementPolicy()
 */
@@ -12,24 +12,23 @@
 /*!
     \enum QskPlacementPolicy::Policy
 
-	Hint for the layout code how to deal with the geometry of an
+    Hint for the layout code how to deal with the geometry of an
-	item. QskPlacementPolicy has two values one for the visible,
+    item. QskPlacementPolicy has two values: one for the visible,
-	the other for the hidden state.
+    the other for the hidden state.
 
     \var QskPlacementPolicy::Ignore
 
-         Ignore the item for all type of layout calculations.
+         Ignore the item for all type of layout calculations
 
     \var QskPlacementPolicy::Reserve
 
-         Reseve space without giving the item its geometry.
+         Reseve space without giving the item its geometry
 
     \var QskPlacementPolicy::Adjust
 
          Reserve space and adjust the geometry of the item
 
-	\note QskPlacementPolicy::Reserve as hiddenPolicy() is equivalent
+    \sa visiblePolicy, hiddenPolicy
-	      to what is offered by QSizePolicy::retainSizeWhenHidden().
 */
 
 /*!
@@ -37,27 +36,27 @@
 
     \brief Policy for the item, when being visible ( to its parent )
 
-	- QskPlacementPolicy::Ignore
+    - QskPlacementPolicy::Ignore
 
       For situations where a parent takes care of the geometry for its children,
-      but exceptions need to be defined. F.e a focus indicator.
+      but the specific item should be omitted. F.e a focus indicator.
 
-	- QskPlacementPolicy::Reserve:
+    - QskPlacementPolicy::Reserve
 
-	  There are not many relevant scenarios for this value. An
+      There are not many relevant scenarios for reserving space for visible items
-	  example might be when an item is inside of a grid layout, where all the
+      without adjusting them. An example might be when an item is inside of a
-	  size hints should have an effect, but the final alignment of the item
+      grid box, where all the size hints should have an effect, but the final
-	  inside of the cell has to be done manually.
+      alignment of the item inside of the cell has to be done manually.
 
-	- QskPlacementPolicy::Adjust:
+    - QskPlacementPolicy::Adjust:
 
       The default value
 
     \accessors visiblePolicy(), setVisiblePolicy()
-	\sa hiddenPolicy, qskIsVisibleToParent()
+    \sa hiddenPolicy, QskQuickItem::isVisibleToParent(), qskIsVisibleToParent()
 
     \note QskPlacementPolicy::Ignore is stored in the transparentForPositioner
-	      bit in QQuickItem and might have an impact on Qt/Quick layout code.
+          bit in QQuickItem and might have an impact on Qt/Quick layout code.
 */
 
 /*!
@@ -78,99 +77,107 @@
     
       Sometimes an item wants to have its proper size even when being hidden.
       
-    \accessors visiblePolicy(), setVisiblePolicy()
+    \accessors hiddenPolicy(), setHiddenPolicy()
-    \sa qskIsVisibleToParent()
+    \sa visiblePolicy, QskQuickItem::isVisibleToParent(), qskIsVisibleToParent()
     
     \note QskPlacementPolicy::Ignore is stored in the transparentForPositioner
           bit in QQuickItem and might have an impact on Qt/Quick layout code.
+
+    \note QskPlacementPolicy::Reserve is equivalent to what is offered by
+          \saqt QSizePolicy::retainSizeWhenHidden().
 */
 
 /*!
     \fn QskPlacementPolicy::QskPlacementPolicy()
 
-    visiblePolicy is set to QskPlacementPolicy::Adjust,
+    \brief Default constructor
-	hiddenPolicy to QskPlacementPolicy::Ignore.
+
+    QskPlacementPolicy::Adjust is set for Qsk::Visible, while
+    QskPlacementPolicy::Ignore is used for Qsk::Hidden.
+
+    \sa visiblePolicy, hiddenPolicy
 */
 
 /*!
     \fn QskPlacementPolicy::QskPlacementPolicy( Policy policy )
 
-	visiblePolicy and hiddenPolicy are set to policy
+    visiblePolicy and hiddenPolicy are set to policy
 */
 
 /*!
     \fn QskPlacementPolicy::QskPlacementPolicy( Policy visiblePolicy, Policy hiddenPolicy )
 
-	Initialization from visiblePolicy and hiddenPolicy
+    Initialization from visiblePolicy and hiddenPolicy
 */
 
 /*! 
     \fn QskPlacementPolicy::QskPlacementPolicy( Qsk::Visibilities visiblities, Policy policy )
 
-	Initialize visiblePolicy and hiddenPolicy depending on visiblities
+    Initialize visiblePolicy and hiddenPolicy depending on visiblities
 */
 
-/*
+/*!
     \fn QskPlacementPolicy::operator==( const QskPlacementPolicy& )
 
     "Equal to" operator
     \sa operator!=(), operator<()
 */
 
-/*
+/*!
     \fn QskPlacementPolicy::operator!=( const QskPlacementPolicy& )
 
-	"Not equal to" operator
+    "Not equal to" operator
     \sa operator==(), operator<()
 */
 
-/*
+/*!
     \fn QskPlacementPolicy::setPolicy( Qsk::Visibilities, Policy )
 */
 
-*/
+/*!
     \fn QskPlacementPolicy::policy( Qsk::Visibility )
 */
 
-/*
+/*!
     \fn QskPlacementPolicy::isEffective()
 
-	\return true, when visiblePolicy or hiddenPolicy is not QskPlacementPolicy::Ignore
+    \return true, when visiblePolicy or hiddenPolicy is not QskPlacementPolicy::Ignore
-	\sa isIgnoring()
+    \sa isIgnoring()
 */
 
-/*
+/*!
     \fn QskPlacementPolicy::isIgnoring( Qsk::Visibility )
-	\return true, when visiblePolicy and hiddenPolicy is QskPlacementPolicy::Ignore
+
-	\sa isEffective()
+    \return true, when visiblePolicy and hiddenPolicy are set to QskPlacementPolicy::Ignore
+    \sa isEffective()
 */
 
-/*
+/*!
     \fn QskPlacementPolicy::isAdjusting( Qsk::Visibility )
 
-	\return true, when QskPlacementPolicy::Adjust is set for the visibility
+    \return true, when QskPlacementPolicy::Adjust is set for the visibility
 */
 
-/*
+/*!
     \fn QskPlacementPolicy::setVisiblePolicy( Policy )
 
-	\sa visiblePolicy(), setHiddenPolicy()
+    \sa visiblePolicy(), setHiddenPolicy()
 */
 
-/*
+/*!
     \fn QskPlacementPolicy::visiblePolicy()
 
-	\sa setVisiblePolicy(), hiddenPolicy()
+    \sa setVisiblePolicy(), hiddenPolicy()
 */
 
-/*
+/*!
     \fn QskPlacementPolicy::setHiddenPolicy( Policy )
 
-	\sa hiddenPolicy(), setVisiblePolicy()
+    \sa hiddenPolicy(), setVisiblePolicy()
 */
 
-/*
+/*!
     \fn QskPlacementPolicy::hiddenPolicy()
 
-	\sa setHiddenPolicy(), visiblePolicy()
+    \sa setHiddenPolicy(), visiblePolicy()
 */

doc/classes/QskQuickItem.dox

@@ -137,7 +137,7 @@
     it is necessary to know which children would stay hidden when the container
     becomes visible.
 
-    \sa isVisibleToParent()
+    \sa setHidden(), show(), hide(), isVisibleToParent(), qskIsVisibleToParent()
     \saqt QQuickItem::setVisible()
 */
 
@@ -226,7 +226,7 @@
     
     \return true once setVisible( false ) has been called
 
-    \sa visibleToParent
+    \sa visibleToParent(), qskIsVisibleToParent()
     \saqt QQuickItem::setVisible()
 */
 
@@ -562,7 +562,7 @@
     An alternative way to call setVisible( true ).
     Useful for signal/slot connections
 
-    \sa hide()
+    \sa hide(), setHidden()
     \saqt QQuickItem::setVisible()
 */
 
@@ -579,8 +579,10 @@
 /*!
     \fn QskQuickItem::setHidden
 
-        Convenience function, equivalent to setVisible( !on ).
+     Convenience function, equivalent to setVisible( !on ).
-        \saqt QQuickItem::setVisible()
+
+     \sa show(), hide()
+     \saqt QQuickItem::setVisible()
 */
 
 /*!