Doc: corrections, spelling, and ListView requirements comments
authorDavid Fries <David@Fries.net>
Wed, 8 May 2013 05:14:25 +0000 (00:14 -0500)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Wed, 15 May 2013 07:32:58 +0000 (09:32 +0200)
From the ListView comment I thought the model had to be derived from
QAbstractListModel, but that's not the case, QAbstractListModel will
work just fine, it just doesn't support specific cases such as trees.

Change-Id: I59305006540ddc049e276cf412571373cbfa6c67
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Gunnar Sletta <gunnar.sletta@digia.com>
src/qml/qml/qqmlcomponent.cpp
src/quick/items/qquicklistview.cpp
src/quick/scenegraph/coreapi/qsggeometry.cpp
src/quick/scenegraph/coreapi/qsgnode.cpp
src/quick/scenegraph/util/qsgtexturematerial.cpp

index 73f778e..ccef0a6 100644 (file)
@@ -1226,9 +1226,8 @@ void QQmlComponent::createObject(QQmlV8Function *args)
     instances to be instantiated asynchronously and not cause freezes in the UI.
 
     The \a parent argument specifies the parent the created instance will have.  Omitting the
-    parameter or passing null will create anobject with no parent.  In this case, a reference
-    to the created object must be maintained by the application of the object will eventually
-    be garbage collected.
+    parameter or passing null will create an object with no parent.  In this case, a reference
+    to the created object must be held so that it is not destroyed by the garbage collector.
 
     The \a properties argument is specified as a map of property-value items which will be
     set on the created object during its construction.  \a mode may be Qt.Synchronous or
index cf31eb7..c5e96a3 100644 (file)
@@ -1659,7 +1659,7 @@ bool QQuickListViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte
 
     A ListView displays data from models created from built-in QML types like ListModel
     and XmlListModel, or custom model classes defined in C++ that inherit from
-    QAbstractListModel.
+    QAbstractItemModel or QAbstractListModel.
 
     A ListView has a \l model, which defines the data to be displayed, and
     a \l delegate, which defines how the data should be displayed. Items in a
index 818b9b2..a82c857 100644 (file)
@@ -332,42 +332,42 @@ const QSGGeometry::AttributeSet &QSGGeometry::defaultAttributes_ColoredPoint2D()
 /*!
     \fn const QSGGeometry::ColoredPoint2D *QSGGeometry::vertexDataAsColoredPoint2D() const
 
-    Convenience function to access the vertex data as an immuatble
+    Convenience function to access the vertex data as an immutable
     array of QSGGeometry::ColoredPoint2D.
  */
 
 /*!
     \fn QSGGeometry::ColoredPoint2D *QSGGeometry::vertexDataAsColoredPoint2D()
 
-    Convenience function to access the vertex data as a muatble
+    Convenience function to access the vertex data as a mutable
     array of QSGGeometry::ColoredPoint2D.
  */
 
 /*!
     \fn const QSGGeometry::TexturedPoint2D *QSGGeometry::vertexDataAsTexturedPoint2D() const
 
-    Convenience function to access the vertex data as an immuatble
+    Convenience function to access the vertex data as an immutable
     array of QSGGeometry::TexturedPoint2D.
  */
 
 /*!
     \fn QSGGeometry::TexturedPoint2D *QSGGeometry::vertexDataAsTexturedPoint2D()
 
-    Convenience function to access the vertex data as a muatble
+    Convenience function to access the vertex data as a mutable
     array of QSGGeometry::TexturedPoint2D.
  */
 
 /*!
     \fn const QSGGeometry::Point2D *QSGGeometry::vertexDataAsPoint2D() const
 
-    Convenience function to access the vertex data as an immuatble
+    Convenience function to access the vertex data as an immutable
     array of QSGGeometry::Point2D.
  */
 
 /*!
     \fn QSGGeometry::Point2D *QSGGeometry::vertexDataAsPoint2D()
 
-    Convenience function to access the vertex data as a muatble
+    Convenience function to access the vertex data as a mutable
     array of QSGGeometry::Point2D.
  */
 
index 6a22e0e..f30e95d 100644 (file)
@@ -128,12 +128,12 @@ static void qt_print_node_count()
     before rendering starts.
     \value OwnsGeometry Only valid for QSGGeometryNode and QSGClipNode.
     The node has ownership over the QSGGeometry instance and will
-    delete it when the node is destroyed.
+    delete it when the node is destroyed or a geometry is assigned.
     \value OwnsMaterial Only valid for QSGGeometryNode. The node has ownership
-    over the material and will delete it when the node is destroyed.
+    over the material and will delete it when the node is destroyed or a material is assigned.
     \value OwnsOpaqueMaterial Only valid for QSGGeometryNode. The node has
     ownership over the opaque material and will delete it when the node is
-    destroyed.
+    destroyed or a material is assigned.
  */
 
 /*!
index ff91109..8741476 100644 (file)
@@ -145,7 +145,7 @@ void QSGOpaqueTextureMaterialShader::updateState(const RenderState &state, QSGMa
     tuple. The QSGGeometry::defaultAttributes_TexturedPoint2D returns an
     attribute set compatible with this material.
 
-    The texture to be rendered is can be set using setTexture(). How the
+    The texture to be rendered can be set using setTexture(). How the
     texture should be rendered can be specified using setMipmapFiltering(),
     setFiltering(), setHorizontalWrapMode() and setVerticalWrapMode().
     The rendering state is set on the texture instance just before it
@@ -208,7 +208,7 @@ QSGMaterialShader *QSGOpaqueTextureMaterial::createShader() const
 /*!
     Sets the texture of this material to \a texture.
 
-    The material does not take ownership over the texture.
+    The material does not take ownership of the texture.
  */
 
 void QSGOpaqueTextureMaterial::setTexture(QSGTexture *texture)
@@ -337,7 +337,7 @@ int QSGOpaqueTextureMaterial::compare(const QSGMaterial *o) const
     tuple. The QSGGeometry::defaultAttributes_TexturedPoint2D returns an
     attribute set compatible with this material.
 
-    The texture to be rendered is set using setTexture(). How the
+    The texture to be rendered can be set using setTexture(). How the
     texture should be rendered can be specified using setMipmapFiltering(),
     setFiltering(), setHorizontalWrapMode() and setVerticalWrapMode().
     The rendering state is set on the texture instance just before it