Doc: A few cleanups, fixes and improvements.

14 files changed, 38 insertions, 34 deletions

diff --git a/src/3rdparty/webkit/WebKit/qt/Api/qwebdatabase.cpp b/src/3rdparty/webkit/WebKit/qt/Api/qwebdatabase.cpp
index 2b25f95..7e85eaa 100644
--- a/src/3rdparty/webkit/WebKit/qt/Api/qwebdatabase.cpp
+++ b/src/3rdparty/webkit/WebKit/qt/Api/qwebdatabase.cpp
@@ -149,7 +149,7 @@ QWebSecurityOrigin QWebDatabase::origin() const
 }
 
 /*!
-    Removes the database, \a db, from its security origin. All data stored in this database
+    Removes the database \a db from its security origin. All data stored in this database
     will be destroyed.
 */
 void QWebDatabase::removeDatabase(const QWebDatabase &db)
diff --git a/src/activeqt/container/qaxobject.cpp b/src/activeqt/container/qaxobject.cpp
index 412c5b5..63bdd5e 100644
--- a/src/activeqt/container/qaxobject.cpp
+++ b/src/activeqt/container/qaxobject.cpp
@@ -122,7 +122,7 @@ QAxObject::~QAxObject()
 }
 
 /*!
-    \reimp
+    \internal
 */
 const QMetaObject *QAxObject::metaObject() const
 {
@@ -130,7 +130,7 @@ const QMetaObject *QAxObject::metaObject() const
 }
 
 /*!
-    \reimp
+    \internal
 */
 const QMetaObject *QAxObject::parentMetaObject() const
 {
@@ -148,7 +148,7 @@ void *QAxObject::qt_metacast(const char *cname)
 }
 
 /*!
-    \reimp
+    \internal
 */
 const char *QAxObject::className() const
 {
@@ -156,7 +156,7 @@ const char *QAxObject::className() const
 }
 
 /*!
-    \reimp
+    \internal
 */
 int QAxObject::qt_metacall(QMetaObject::Call call, int id, void **v)
 {
diff --git a/src/activeqt/container/qaxwidget.cpp b/src/activeqt/container/qaxwidget.cpp
index 615887f..ae468ef 100644
--- a/src/activeqt/container/qaxwidget.cpp
+++ b/src/activeqt/container/qaxwidget.cpp
@@ -2034,7 +2034,7 @@ bool QAxWidget::doVerb(const QString &verb)
 */
 
 /*!
-    \reimp
+    \internal
 */
 const QMetaObject *QAxWidget::metaObject() const
 {
@@ -2042,7 +2042,7 @@ const QMetaObject *QAxWidget::metaObject() const
 }
 
 /*!
-    \reimp
+    \internal
 */
 const QMetaObject *QAxWidget::parentMetaObject() const
 {
@@ -2060,7 +2060,7 @@ void *QAxWidget::qt_metacast(const char *cname)
 }
 
 /*!
-    \reimp
+    \internal
 */
 const char *QAxWidget::className() const
 {
@@ -2068,7 +2068,7 @@ const char *QAxWidget::className() const
 }
 
 /*!
-    \reimp
+    \internal
 */
 int QAxWidget::qt_metacall(QMetaObject::Call call, int id, void **v)
 {
diff --git a/src/corelib/animation/qabstractanimation.cpp b/src/corelib/animation/qabstractanimation.cpp
index cf3e62d..ced86d2 100644
--- a/src/corelib/animation/qabstractanimation.cpp
+++ b/src/corelib/animation/qabstractanimation.cpp
@@ -643,9 +643,8 @@ void QAbstractAnimation::stop()
 
 /*!
     Pauses the animation. When the animation is paused, state() returns Paused.
-    The currenttime will remain unchanged until resume() or start() is called.
-    If you want to continue from the current time, call resume().
-
+    The value of currentTime will remain unchanged until resume() or start() 
+    is called. If you want to continue from the current time, call resume().
 
     \sa start(), state(), resume()
  */
diff --git a/src/corelib/animation/qsequentialanimationgroup.cpp b/src/corelib/animation/qsequentialanimationgroup.cpp
index 5932e7c..05dc307 100644
--- a/src/corelib/animation/qsequentialanimationgroup.cpp
+++ b/src/corelib/animation/qsequentialanimationgroup.cpp
@@ -269,8 +269,10 @@ QSequentialAnimationGroup::~QSequentialAnimationGroup()
 
 /*!
     Adds a pause of \a msecs to this animation group.
-    The pause is considered as a special type of animation, thus count() will be
+    The pause is considered as a special type of animation, thus 
+    \l{QAnimationGroup::animationCount()}{animationCount} will be 
     increased by one.
+
     \sa insertPauseAt(), QAnimationGroup::addAnimation()
 */
 QPauseAnimation *QSequentialAnimationGroup::addPause(int msecs)
diff --git a/src/corelib/tools/qcontiguouscache.cpp b/src/corelib/tools/qcontiguouscache.cpp
index 8a14152..61cda52 100644
--- a/src/corelib/tools/qcontiguouscache.cpp
+++ b/src/corelib/tools/qcontiguouscache.cpp
@@ -96,7 +96,7 @@ MyRecord record(int row) const
     in the case where the requested row is a long way from the currently cached
     items. If there is a gap between where the new item is inserted and the currently
     cached items then the existing cached items are first removed to retain
-    the contiguous nature of the cache.  Hence it is important to take some care then
+    the contiguous nature of the cache. Hence it is important to take some care then
     when using insert() in order to avoid unwanted clearing of the cache.
 
     The range of valid indexes for the QContiguousCache class are from
@@ -105,9 +105,9 @@ MyRecord record(int row) const
     than INT_MAX can result in the indexes of the cache being invalid.
     When the cache indexes are invalid it is important to call
     normalizeIndexes() before calling any of containsIndex(), firstIndex(),
-    lastIndex(), at() or the [] operator.  Calling these
-    functions when the cache has invalid indexes will result in undefined
-    behavior.  The indexes can be checked by using areIndexesValid()
+    lastIndex(), at() or \l{QContiguousCache::operator[]()}{operator[]()}.
+    Calling these functions when the cache has invalid indexes will result in
+    undefined behavior. The indexes can be checked by using areIndexesValid()
 
     In most cases the indexes will not exceed 0 to INT_MAX, and
     normalizeIndexes() will not need to be used.
@@ -259,14 +259,15 @@ MyRecord record(int row) const
 
 /*! \fn T &QContiguousCache::operator[](int i)
 
-    Returns the item at index position \a i as a modifiable reference.  If
+    Returns the item at index position \a i as a modifiable reference. If
     the cache does not contain an item at the given index position \a i
     then it will first insert an empty item at that position.
 
     In most cases it is better to use either at() or insert().
 
-    Note that using non-const operators can cause QContiguousCache to do a deep
-    copy.
+    \note This non-const overload of operator[] requires QContiguousCache 
+    to make a deep copy. Use at() for read-only access to a non-const 
+    QContiguousCache.
 
     \sa insert(), at()
 */
diff --git a/src/gui/graphicsview/qgraphicsitem.cpp b/src/gui/graphicsview/qgraphicsitem.cpp
index 7d5ce7b..5ef6219 100644
--- a/src/gui/graphicsview/qgraphicsitem.cpp
+++ b/src/gui/graphicsview/qgraphicsitem.cpp
@@ -3189,7 +3189,7 @@ void QGraphicsItem::setShear(qreal sh, qreal sv)
 /*!
     \since 4.6
 
-    Returns the origin point used for transformation in item coordinate.
+    Returns the origin point for the transformation in item coordinates.
 
     The default is QPointF(0,0).
 
@@ -3205,7 +3205,7 @@ QPointF QGraphicsItem::transformOrigin() const
 /*!
     \since 4.6
 
-    Sets the \a origin for transformation in item coordinate
+    Sets the \a origin point for the transformation in item coordinates.
 
     \sa transformOrigin(), {Transformations}
 */
@@ -3226,9 +3226,9 @@ void QGraphicsItem::setTransformOrigin(const QPointF &origin)
     \since 4.6
     \overload
 
-    Sets the origin for the transformation to the point
-    composed of \a x and \a y.
-    
+    Sets the origin point for the transformation in item coordinates.
+    This is equivalent to calling setTransformOrigin(QPointF(\a x, \a y)).
+
     \sa setTransformOrigin(), {Transformations}
 */
 
diff --git a/src/gui/image/qimage.cpp b/src/gui/image/qimage.cpp
index fa1ce29..ad55dcd 100644
--- a/src/gui/image/qimage.cpp
+++ b/src/gui/image/qimage.cpp
@@ -5269,7 +5269,7 @@ QPaintEngine *QImage::paintEngine() const
 
 
 /*!
-    \reimp
+    \internal
 
     Returns the size for the specified \a metric on the device.
 */
diff --git a/src/gui/image/qpicture.cpp b/src/gui/image/qpicture.cpp
index 874de81..ea1392b 100644
--- a/src/gui/image/qpicture.cpp
+++ b/src/gui/image/qpicture.cpp
@@ -954,6 +954,8 @@ bool QPicture::exec(QPainter *painter, QDataStream &s, int nrecords)
 }
 
 /*!
+    \internal
+
     Internal implementation of the virtual QPaintDevice::metric()
     function.
 
diff --git a/src/gui/image/qpixmap.cpp b/src/gui/image/qpixmap.cpp
index 15bbccb..72fdec0 100644
--- a/src/gui/image/qpixmap.cpp
+++ b/src/gui/image/qpixmap.cpp
@@ -1782,7 +1782,7 @@ bool QPixmap::hasAlphaChannel() const
 }
 
 /*!
-  \reimp
+    \internal
 */
 int QPixmap::metric(PaintDeviceMetric metric) const
 {
@@ -1857,7 +1857,7 @@ QPixmap QPixmap::alphaChannel() const
 }
 
 /*!
-  \reimp
+    \internal
 */
 QPaintEngine *QPixmap::paintEngine() const
 {
diff --git a/src/gui/painting/qprinter.cpp b/src/gui/painting/qprinter.cpp
index 8823b18..411b74d 100644
--- a/src/gui/painting/qprinter.cpp
+++ b/src/gui/painting/qprinter.cpp
@@ -793,7 +793,8 @@ QPrinter::OutputFormat QPrinter::outputFormat() const
 
 
 
-/*! \reimp */
+/*! \internal
+*/
 int QPrinter::devType() const
 {
     return QInternal::Printer;
diff --git a/src/gui/text/qsyntaxhighlighter.cpp b/src/gui/text/qsyntaxhighlighter.cpp
index f69562d..56c7ca1 100644
--- a/src/gui/text/qsyntaxhighlighter.cpp
+++ b/src/gui/text/qsyntaxhighlighter.cpp
@@ -367,7 +367,7 @@ QTextDocument *QSyntaxHighlighter::document() const
 /*!
     \since 4.2
 
-    Redoes the highlighting of the whole document.
+    Reapplies the highlighting to the whole document.
 
     \sa rehighlightBlock()
 */
@@ -384,7 +384,7 @@ void QSyntaxHighlighter::rehighlight()
 /*!
     \since 4.6
 
-    Redoes the highlighting of the given QTextBlock \a block.
+    Reapplies the highlighting to the given QTextBlock \a block.
     
     \sa rehighlight()
 */
diff --git a/src/opengl/qglframebufferobject.cpp b/src/opengl/qglframebufferobject.cpp
index df89e24..3685661 100644
--- a/src/opengl/qglframebufferobject.cpp
+++ b/src/opengl/qglframebufferobject.cpp
@@ -1032,8 +1032,7 @@ GLuint QGLFramebufferObject::handle() const
 }
 
 /*! \fn int QGLFramebufferObject::devType() const
-
-    \reimp
+    \internal
 */
 
 
diff --git a/src/opengl/qglpixelbuffer.cpp b/src/opengl/qglpixelbuffer.cpp
index 38fad4e..440694d 100644
--- a/src/opengl/qglpixelbuffer.cpp
+++ b/src/opengl/qglpixelbuffer.cpp
@@ -591,7 +591,7 @@ QGLFormat QGLPixelBuffer::format() const
 }
 
 /*! \fn int QGLPixelBuffer::devType() const
-    \reimp
+    \internal
 */
 
 QT_END_NAMESPACE