Doc: Fixed qdoc warnings.
authorDavid Boddie <david.boddie@nokia.com>
Wed, 11 May 2011 12:19:37 +0000 (14:19 +0200)
committerDavid Boddie <david.boddie@nokia.com>
Mon, 23 May 2011 12:27:59 +0000 (14:27 +0200)
src/declarative/graphicsitems/qdeclarativegridview.cpp
src/declarative/graphicsitems/qdeclarativeitem.cpp
src/declarative/qml/qdeclarativetypeloader.cpp

index a3395a4..63dfc4e 100644 (file)
@@ -1799,7 +1799,7 @@ void QDeclarativeGridView::setHighlightRangeMode(HighlightRangeMode mode)
   \o Qt.LeftToRight (default) - Items will be laid out starting in the top, left corner. The flow is
   dependent on the \l GridView::flow property.
   \o Qt.RightToLeft - Items will be laid out starting in the top, right corner. The flow is dependent
-  on the \l GridView:flow property.
+  on the \l GridView::flow property.
   \endlist
 
   \bold Note: If GridView::flow is set to GridView.LeftToRight, this is not to be confused if
index 6602dda..0010757 100644 (file)
@@ -2605,6 +2605,17 @@ void QDeclarativeItem::setKeepMouseGrab(bool keep)
     If \a item is a \c null value, this maps the point from the coordinate
     system of the root QML view.
 */
+
+/*!
+    Maps the point (\a x, \a y), which is in \a item's coordinate system, to
+    this item's coordinate system, and returns a script value with \c x and \c y
+    properties matching the mapped cooordinate.
+
+    If \a item is a \c null value, this maps the point from the coordinate
+    system of the root QML view.
+
+    \sa Item::mapFromItem()
+*/
 QScriptValue QDeclarativeItem::mapFromItem(const QScriptValue &item, qreal x, qreal y) const
 {
     QScriptValue sv = QDeclarativeEnginePrivate::getScriptEngine(qmlEngine(this))->newObject();
@@ -2631,6 +2642,17 @@ QScriptValue QDeclarativeItem::mapFromItem(const QScriptValue &item, qreal x, qr
     If \a item is a \c null value, this maps \a x and \a y to the coordinate
     system of the root QML view.
 */
+
+/*!
+    Maps the point (\a x, \a y), which is in this item's coordinate system, to
+    \a item's coordinate system, and returns a script value with \c x and \c y
+    properties matching the mapped cooordinate.
+
+    If \a item is a \c null value, this maps \a x and \a y to the coordinate
+    system of the root QML view.
+
+    \sa Item::mapToItem()
+*/
 QScriptValue QDeclarativeItem::mapToItem(const QScriptValue &item, qreal x, qreal y) const
 {
     QScriptValue sv = QDeclarativeEnginePrivate::getScriptEngine(qmlEngine(this))->newObject();
@@ -2650,8 +2672,17 @@ QScriptValue QDeclarativeItem::mapToItem(const QScriptValue &item, qreal x, qrea
 /*!
     \qmlmethod Item::forceActiveFocus()
 
-    Force active focus on the item.
-    This method sets focus on the item and makes sure that all the focus scopes higher in the object hierarchy are also given focus.
+    Forces active focus on the item.
+
+    This method sets focus on the item and makes sure that all the focus scopes
+    higher in the object hierarchy are also given the focus.
+*/
+
+/*!
+    Forces active focus on the item.
+
+    This method sets focus on the item and makes sure that all the focus scopes
+    higher in the object hierarchy are also given the focus.
 */
 void QDeclarativeItem::forceActiveFocus()
 {
@@ -2670,7 +2701,12 @@ void QDeclarativeItem::forceActiveFocus()
 
   Returns the visible child item at point (\a x, \a y), which is in this
   item's coordinate system, or \c null if there is no such item.
-  */
+*/
+
+/*!
+  Returns the visible child item at point (\a x, \a y), which is in this
+  item's coordinate system, or 0 if there is no such item.
+*/
 QDeclarativeItem *QDeclarativeItem::childAt(qreal x, qreal y) const
 {
     const QList<QGraphicsItem *> children = childItems();
index 26f3996..ff6a7c7 100644 (file)
@@ -434,7 +434,7 @@ void QDeclarativeDataBlob::notifyComplete(QDeclarativeDataBlob *blob)
 
 /*!
 \class QDeclarativeDataLoader
-\brief The QDeclarativeDataLoader class abstracts loading files and their dependecies over the network.
+\brief The QDeclarativeDataLoader class abstracts loading files and their dependencies over the network.
 \internal
 
 The QDeclarativeDataLoader class is provided for the exclusive use of the QDeclarativeTypeLoader class.
@@ -453,9 +453,11 @@ are required before processing can fully complete.
 To complete processing, the QDeclarativeDataBlob::done() callback is invoked.  done() is called when
 one of these three preconditions are met.
 
-1.  The QDeclarativeDataBlob has no dependencies.
-2.  The QDeclarativeDataBlob has an error set.
-3.  All the QDeclarativeDataBlob's dependencies are themselves "done()".
+\list 1
+\o The QDeclarativeDataBlob has no dependencies.
+\o The QDeclarativeDataBlob has an error set.
+\o All the QDeclarativeDataBlob's dependencies are themselves "done()".
+\endlist
 
 Thus QDeclarativeDataBlob::done() will always eventually be called, even if the blob has an error set.
 */
@@ -616,13 +618,17 @@ void QDeclarativeDataLoader::setData(QDeclarativeDataBlob *blob, const QByteArra
 }
 
 /*!
-\class QDeclarativeTypeLoader
+Constructs a new type loader that uses the given \a engine.
 */
 QDeclarativeTypeLoader::QDeclarativeTypeLoader(QDeclarativeEngine *engine)
 : QDeclarativeDataLoader(engine)
 {
 }
 
+/*!
+Destroys the type loader, first clearing the cache of any information about
+loaded files.
+*/
 QDeclarativeTypeLoader::~QDeclarativeTypeLoader()
 {
     clearCache();
@@ -674,7 +680,7 @@ QDeclarativeTypeData *QDeclarativeTypeLoader::get(const QByteArray &data, const
 }
 
 /*!
-Return a QDeclarativeScriptData for \a url.  The QDeclarativeScriptData may be cached.
+Returns a QDeclarativeScriptData for \a url.  The QDeclarativeScriptData may be cached.
 */
 QDeclarativeScriptData *QDeclarativeTypeLoader::getScript(const QUrl &url)
 {
@@ -695,7 +701,7 @@ QDeclarativeScriptData *QDeclarativeTypeLoader::getScript(const QUrl &url)
 }
 
 /*!
-Return a QDeclarativeQmldirData for \a url.  The QDeclarativeQmldirData may be cached.
+Returns a QDeclarativeQmldirData for \a url.  The QDeclarativeQmldirData may be cached.
 */
 QDeclarativeQmldirData *QDeclarativeTypeLoader::getQmldir(const QUrl &url)
 {
@@ -715,6 +721,10 @@ QDeclarativeQmldirData *QDeclarativeTypeLoader::getQmldir(const QUrl &url)
     return qmldirData;
 }
 
+/*!
+Clears cached information about loaded files, including any type data, scripts
+and qmldir information.
+*/
 void QDeclarativeTypeLoader::clearCache()
 {
     for (TypeCache::Iterator iter = m_typeCache.begin(); iter != m_typeCache.end(); ++iter)