qdoc: Added \brief texts to all the since 4.6 functions.

11 files changed, 59 insertions, 21 deletions

diff --git a/src/3rdparty/webkit/WebKit/qt/Api/qwebhistory.cpp b/src/3rdparty/webkit/WebKit/qt/Api/qwebhistory.cpp
index b57272d..7923275 100644
--- a/src/3rdparty/webkit/WebKit/qt/Api/qwebhistory.cpp
+++ b/src/3rdparty/webkit/WebKit/qt/Api/qwebhistory.cpp
@@ -561,8 +561,11 @@ QByteArray QWebHistory::saveState(HistoryStateVersion version) const
   \fn QDataStream& operator<<(QDataStream& stream, const QWebHistory& history)
   \relates QWebHistory
 
-  Saves the given \a history into the specified \a stream. This is a convenience function
-  and is equivalent to calling the saveState() method.
+  \brief The operator<< function streams a history into a data stream.
+
+  It saves the \a history into the specified \a stream. This is a
+  convenience function and is equivalent to calling the saveState()
+  method.
 
   \sa QWebHistory::saveState()
 */
@@ -577,6 +580,8 @@ QDataStream& operator<<(QDataStream& stream, const QWebHistory& history)
   \relates QWebHistory
   \since 4.6
 
+  \brief The operator>> function loads a history from a data stream.
+
   Loads a QWebHistory from the specified \a stream into the given \a history.
   This is a convenience function and it is equivalent to calling the restoreState()
   method.
diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp
index 1d29b3b..4974acf 100644
--- a/src/corelib/global/qglobal.cpp
+++ b/src/corelib/global/qglobal.cpp
@@ -2678,6 +2678,8 @@ int qrand()
     \reentrant
     \since 4.6
 
+    \brief The qtTrId function finds and returns a translated string.
+
     Returns a translated string identified by \a id.
     If no matching string is found, the id itself is returned. This
     should not happen under normal conditions.
@@ -2715,7 +2717,8 @@ int qrand()
     \relates <QtGlobal>
     \since 4.6
 
-    Marks \a id for dynamic translation.
+    \brief The QT_TRID_NOOP macro marks an id for dynamic translation.
+    
     The only purpose of this macro is to provide an anchor for attaching
     meta data like to qtTrId().
 
diff --git a/src/corelib/io/qprocess.cpp b/src/corelib/io/qprocess.cpp
index 6ce38b2..a6a61dd 100644
--- a/src/corelib/io/qprocess.cpp
+++ b/src/corelib/io/qprocess.cpp
@@ -2204,11 +2204,13 @@ QStringList QProcess::systemEnvironment()
 /*!
     \since 4.6
 
-    Returns the environment of the calling process as a QProcessEnvironment.
+    \brief The systemEnvironment function returns the environment of
+    the calling process.
 
-    This function does not cache the system environment. Therefore, it's
-    possible to obtain an updated version of the environment if low-level C
-    library functions like \tt setenv ot \tt putenv have been called.
+    It is returned as a QProcessEnvironment. This function does not
+    cache the system environment. Therefore, it's possible to obtain
+    an updated version of the environment if low-level C library
+    functions like \tt setenv ot \tt putenv have been called.
 
     However, note that repeated calls to this function will recreate the
     QProcessEnvironment object, which is a non-trivial operation.
diff --git a/src/corelib/tools/qsharedpointer.cpp b/src/corelib/tools/qsharedpointer.cpp
index 579d944..fedec08 100644
--- a/src/corelib/tools/qsharedpointer.cpp
+++ b/src/corelib/tools/qsharedpointer.cpp
@@ -1162,6 +1162,8 @@
     \relates QSharedPointer
     \since 4.6
 
+    \brief The qSharedPointerObjectCast function is for casting a shared pointer.
+    
     Returns a shared pointer to the pointer held by \a other, using a
     \l qobject_cast() to type \tt X to obtain an internal pointer of the
     appropriate type. If the \tt qobject_cast fails, the object
@@ -1180,6 +1182,8 @@
     \relates QWeakPointer
     \since 4.6
 
+    \brief The qSharedPointerObjectCast function is for casting a shared pointer.
+
     Returns a shared pointer to the pointer held by \a other, using a
     \l qobject_cast() to type \tt X to obtain an internal pointer of the
     appropriate type. If the \tt qobject_cast fails, the object
diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp
index 9cb2090..ce64c68 100644
--- a/src/gui/kernel/qevent.cpp
+++ b/src/gui/kernel/qevent.cpp
@@ -3776,7 +3776,7 @@ QTouchEvent::~QTouchEvent()
 */
 
 /*! \class QTouchEvent::TouchPoint
-    \brief The QTouchEvent::TouchPoint class provides information about a touch point in a QTouchEvent.
+    \brief The TouchPoint class provides information about a touch point in a QTouchEvent.
     \since 4.6
 */
 
diff --git a/src/gui/kernel/qwidget.cpp b/src/gui/kernel/qwidget.cpp
index 00ad430..ac25435 100644
--- a/src/gui/kernel/qwidget.cpp
+++ b/src/gui/kernel/qwidget.cpp
@@ -4973,7 +4973,10 @@ void QWidget::render(QPainter *painter, const QPoint &targetOffset,
 }
 
 /*!
-    Returns a pointer to this widget's effect if it has one; otherwise 0.
+    \brief The graphicsEffect function returns a pointer to the
+    widget's graphics effect.
+
+    If the widget has no graphics effect, 0 is returned.
 
     \since 4.6
 
@@ -4986,6 +4989,9 @@ QGraphicsEffect *QWidget::graphicsEffect() const
 }
 
 /*!
+
+  \brief The setGraphicsEffect function is for setting the widget's graphics effect.
+  
     Sets \a effect as the widget's effect. If there already is an effect installed
     on this widget, QWidget will delete the existing effect before installing
     the new \a effect.
@@ -6205,7 +6211,8 @@ QWidget *QWidget::nextInFocusChain() const
 }
 
 /*!
-    Returns the previous widget in this widget's focus chain.
+    \brief The previousInFocusChain function returns the previous
+    widget in this widget's focus chain.
 
     \sa nextInFocusChain()
 
@@ -6708,14 +6715,14 @@ bool QWidget::restoreGeometry(const QByteArray &geometry)
 */
 
 /*!
-    Sets the margins around the contents of the widget to have the
-    sizes \a left, \a top, \a right, and \a bottom. The margins are
-    used by the layout system, and may be used by subclasses to
-    specify the area to draw in (e.g. excluding the frame).
+  Sets the margins around the contents of the widget to have the sizes
+  \a left, \a top, \a right, and \a bottom. The margins are used by
+  the layout system, and may be used by subclasses to specify the area
+  to draw in (e.g. excluding the frame).
 
-    Changing the margins will trigger a resizeEvent().
+  Changing the margins will trigger a resizeEvent().
 
-    \sa contentsRect(), getContentsMargins()
+  \sa contentsRect(), getContentsMargins()
 */
 void QWidget::setContentsMargins(int left, int top, int right, int bottom)
 {
@@ -6750,6 +6757,9 @@ void QWidget::setContentsMargins(int left, int top, int right, int bottom)
   \overload
   \since 4.6
 
+  \brief The setContentsMargins function sets the margins around the
+  widget's contents.
+
   Sets the margins around the contents of the widget to have the
   sizes determined by \a margins. The margins are
   used by the layout system, and may be used by subclasses to
@@ -6787,7 +6797,7 @@ void QWidget::getContentsMargins(int *left, int *top, int *right, int *bottom) c
 /*!
   \since 4.6
 
-  Returns the widget's contents margins.
+  \brief The contentsMargins function returns the widget's contents margins.
 
   \sa getContentsMargins(), setContentsMargins(), contentsRect()
  */
diff --git a/src/gui/painting/qdrawutil.cpp b/src/gui/painting/qdrawutil.cpp
index 0a82a9f..716300e 100644
--- a/src/gui/painting/qdrawutil.cpp
+++ b/src/gui/painting/qdrawutil.cpp
@@ -1070,6 +1070,9 @@ void qDrawItem(QPainter *p, Qt::GUIStyle gs,
     \since 4.6
     \overload
 
+    \brief The qDrawBorderPixmap function is for drawing a pixmap into
+    the margins of a rectangle.
+
     Draws the given \a pixmap into the given \a target rectangle, using the
     given \a painter. The pixmap will be split into nine segments and drawn
     according to the \a margins structure.
diff --git a/src/gui/painting/qmatrix.cpp b/src/gui/painting/qmatrix.cpp
index 0f0d405..88b2b7a 100644
--- a/src/gui/painting/qmatrix.cpp
+++ b/src/gui/painting/qmatrix.cpp
@@ -1209,6 +1209,9 @@ QDebug operator<<(QDebug dbg, const QMatrix &m)
     \relates QMatrix
     \since 4.6
 
+    \brief The qFuzzyCompare function is for comparing two matrices
+    using a fuzziness factor.
+    
     Returns true if \a m1 and \a m2 are equal, allowing for a small
     fuzziness factor for floating-point comparisons; false otherwise.
 */
diff --git a/src/testlib/qtestcase.cpp b/src/testlib/qtestcase.cpp
index 96f8a1b..3392ed7 100644
--- a/src/testlib/qtestcase.cpp
+++ b/src/testlib/qtestcase.cpp
@@ -362,6 +362,9 @@ QT_BEGIN_NAMESPACE
 
     \relates QTest
 
+    \brief The QBENCHMARK_ONCE macro is for measuring performance of a
+    code block by running it once.
+
     This macro is used to measure the performance of code within a test.
     The code to be benchmarked is contained within a code block following
     this macro.
diff --git a/tools/qdoc3/doc.cpp b/tools/qdoc3/doc.cpp
index e27209c..c202d71 100644
--- a/tools/qdoc3/doc.cpp
+++ b/tools/qdoc3/doc.cpp
@@ -2668,13 +2668,18 @@ Text Doc::trimmedBriefText(const QString &className) const
 	    standardWording = false;
         }
 
-        if (!w.isEmpty() && (w.first() == "class" || w.first() == "widget"
-                             || w.first() == "namespace" || w.first() == "header"))
+        if (!w.isEmpty() && ((w.first() == "class") ||
+                             (w.first() == "function") ||
+                             (w.first() == "macro") ||
+                             (w.first() == "widget") ||
+                             (w.first() == "namespace") ||
+                             (w.first() == "header")))
 	    w.removeFirst();
         else {
 	    location().warning(
                 tr("Nonstandard wording in '\\%1' text for '%2' ("
-                   "expected 'class', 'widget', 'namespace' or 'header')")
+                   "expected 'class', 'function', 'macro', 'widget', "
+                   "'namespace' or 'header')")
                 .arg(COMMAND_BRIEF).arg(className));
 	    standardWording = false;
         }
diff --git a/tools/qdoc3/test/qt.qdocconf b/tools/qdoc3/test/qt.qdocconf
index 942d023..e989124 100644
--- a/tools/qdoc3/test/qt.qdocconf
+++ b/tools/qdoc3/test/qt.qdocconf
@@ -6,7 +6,7 @@ include(qt-defines.qdocconf)
 
 project                 = Qt
 versionsym              =
-version                 = %VERSION%
+version                 = 4.6
 description             = Qt Reference Documentation
 url                     = http://qt.nokia.com/doc/4.6