Doc: Cleaned up the scene graph documentation a little.
authorDavid Boddie <david.boddie@nokia.com>
Thu, 9 Jun 2011 13:23:08 +0000 (15:23 +0200)
committerDavid Boddie <david.boddie@nokia.com>
Thu, 9 Jun 2011 13:23:35 +0000 (15:23 +0200)
35 files changed:
src/declarative/items/qsganchors.cpp
src/declarative/items/qsganimatedimage.cpp
src/declarative/items/qsganimation.cpp
src/declarative/items/qsgborderimage.cpp
src/declarative/items/qsgclipnode.cpp
src/declarative/items/qsgevents.cpp
src/declarative/items/qsgflickable.cpp
src/declarative/items/qsgflipable.cpp
src/declarative/items/qsgfocusscope.cpp
src/declarative/items/qsggridview.cpp
src/declarative/items/qsgimage.cpp
src/declarative/items/qsgimagebase.cpp
src/declarative/items/qsgimplicitsizeitem.cpp
src/declarative/items/qsgitem.cpp
src/declarative/items/qsgitemsmodule.cpp
src/declarative/items/qsglistview.cpp
src/declarative/items/qsgloader.cpp
src/declarative/items/qsgmousearea.cpp
src/declarative/items/qsgpathview.cpp
src/declarative/items/qsgpincharea.cpp
src/declarative/items/qsgpositioners.cpp
src/declarative/items/qsgrectangle.cpp
src/declarative/items/qsgrepeater.cpp
src/declarative/items/qsgscalegrid.cpp
src/declarative/items/qsgshadereffectsource.cpp
src/declarative/items/qsgstateoperations.cpp
src/declarative/items/qsgtext.cpp
src/declarative/items/qsgtextedit.cpp
src/declarative/items/qsgtextinput.cpp
src/declarative/items/qsgtranslate.cpp
src/declarative/items/qsgview.cpp
src/declarative/items/qsgvisualitemmodel.cpp
src/declarative/scenegraph/coreapi/qsgnode.cpp
src/declarative/scenegraph/qsgcontext.cpp
src/declarative/scenegraph/qsgflashnode.cpp

index ff9351e..b491894 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 2c7cab4172f1acc86fd49345a2847417e162f2c3
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index f036042..0d7fb95 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: af33f9f2e7ec433b81f5c18e3e7395db4a56c5fe
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index ad6ed03..ef21ec5 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 91501cc9b542de644cd70098a6bc5ff738cdeb49
 /****************************************************************************
 **
 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
index 81df0a3..a0bb72e 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 462429f5692f810bdd4e04b916db5f9af428d9e4
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 2e40972..b0a0a56 100644 (file)
@@ -1,4 +1,3 @@
-
 /****************************************************************************
 **
 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
index 44ef38b..773a3e3 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: ac5c099cc3c5b8c7eec7a49fdeb8a21037230350
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index be0ac13..48beef8 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: d4fa1878ff1e7628d3e984d54f8a93810353c71b
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index a856d63..0439a4d 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: caee66da925949cf7aef2ff8e1a86c38dd6e6efd
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 84f19b1..07fafc3 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: ac5c099cc3c5b8c7eec7a49fdeb8a21037230350
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index b65cd39..ef4e969 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 806f031efeda71d3f4d7d2f949b437493e79cf52
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 706aaa7..2e38313 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 051a76c1d65d698f71dc75c89f91ae9021357eae
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 9f2de03..70a6f6d 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 051a76c1d65d698f71dc75c89f91ae9021357eae
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index f2cc9bc..f8e5b5f 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 6f78a6080b84cc3ef96b73a4ff58d1b5a72f08f4
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index f2d2695..2bba4da 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: c44be8c0b27756a2025ebad1945632f3f7e4bebc
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 6ea20bb..e5fcfee 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 2c7cab4172f1acc86fd49345a2847417e162f2c3
 /****************************************************************************
 **
 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
index a61ca97..eea5465 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 806f031efeda71d3f4d7d2f949b437493e79cf52
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 6717098..e5b7e49 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 501180c6fbed0857126da2bb0ff1f17ee35472c6
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 887d78a..62b1495 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: e1ffbc04131dc6f76fa76821c297d08162e4b1ee
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index fc3d39a..35b6e03 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 806f031efeda71d3f4d7d2f949b437493e79cf52
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index f21d873..6fc0c61 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: f707672eb4c51ea82fbd98e1da16ece61a74c690
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index f174612..0106d8f 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 1f38d41854fa2daa51d938a4eb398752b1751e0b
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index e97abe3..09bf34d 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: acc903853d5ac54d646d324b7386c998bc07d464
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index ac6086f..3a0ef84 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: a9f1eaa6a368bf7a72b52c428728a3e3e0a76209
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 4a73801..9f1b7bf 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 7ddec9f3179bfd854ae53e23ab292de1f9a26377
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index e2c50bb..ba11660 100644 (file)
@@ -391,6 +391,7 @@ void QSGShaderEffectTexture::grab()
        rather than each element individually.
     \endlist
 
+    \table
     \row
     \o \image declarative-shadereffectsource.png
     \o \qml
@@ -420,6 +421,7 @@ void QSGShaderEffectTexture::grab()
         }
         \endqml
     \endrow
+    \endtable
 
     The ShaderEffectSource element does not redirect any mouse or keyboard
     input to \l sourceItem. If you hide the \l sourceItem by setting
index 5390440..0c6491e 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 726a8b16c52fe4608c89d740b47361a2b073ce01
 /****************************************************************************
 **
 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
index e7e655d..b99e929 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: cce89db1e2555cbca8fc28072e1c6dd737cec6c4
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 1c199ec..01d068d 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: ec40dd2bb51868bca10dbd0c9116f3224ff2b29b
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 1db4474..94f5471 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 47712d1f330e4b22ce6dd30e7557288ef7f7fca0
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 5f7112b..1c453d6 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: ac5c099cc3c5b8c7eec7a49fdeb8a21037230350
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 1169c59..830a232 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: 55c4d94dfea78951f3371d3697a3cb28539b3012
 /****************************************************************************
 **
 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
index daf67b5..a24b65f 100644 (file)
@@ -1,4 +1,3 @@
-// Commit: dcb9148091cbf6872b60407c301d7c92427583a6
 /****************************************************************************
 **
 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
index 3472c93..370cfa4 100644 (file)
@@ -60,7 +60,7 @@ static void qt_print_node_count()
 
 /*!
     \class QSGNode
-    \bried The QSGNode class is the base class for all nodes in the scene graph.
+    \brief The QSGNode class is the base class for all nodes in the scene graph.
 
     The QSGNode class can be used as a child container. Children are added with
     the appendChildNode(), prependChildNode(), insertChildNodeBefore() and
@@ -927,7 +927,7 @@ bool QSGOpacityNode::isSubtreeBlocked() const
 
 /*!
     \class QSGNodeVisitor
-    \bried The QSGNodeVisitor class is a helper class for traversing the scene graph.
+    \brief The QSGNodeVisitor class is a helper class for traversing the scene graph.
 
     \internal
  */
index 55942be..6164747 100644 (file)
@@ -63,7 +63,7 @@
 DEFINE_BOOL_CONFIG_OPTION(qmlFlashMode, QML_FLASH_MODE)
 DEFINE_BOOL_CONFIG_OPTION(qmlTranslucentMode, QML_TRANSLUCENT_MODE)
 
-/*!
+/*
     Comments about this class from Gunnar:
 
     The QSGContext class is right now two things.. The first is the
@@ -78,8 +78,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlTranslucentMode, QML_TRANSLUCENT_MODE)
     If we ever move the scene graph core API into its own thing, this class
     needs to be split in two. Right now its one because we're lazy when it comes
     to defining plugin interfaces..
-
- */
+*/
 
 
 QT_BEGIN_NAMESPACE
@@ -400,7 +399,7 @@ QSGMaterialShader *QSGContext::prepareMaterial(QSGMaterial *material)
 
 
 /*!
-    Sets weither the scene graph should render with flashing update rectangles or not
+    Sets whether the scene graph should render with flashing update rectangles or not
   */
 
 void QSGContext::setFlashModeEnabled(bool enabled)