From 66fc43343b06575a97b84ad44d70fd3082a6140e Mon Sep 17 00:00:00 2001
From: Martin Smith <msmith@trolltech.com>
Date: Wed, 2 Sep 2009 12:34:29 +0200
Subject: doc: Fixed several qdoc errors.

That's the last of them... for now.
---
 doc/src/platforms/emb-deployment.qdoc    |  4 ++--
 doc/src/platforms/emb-running.qdoc       |  2 +-
 doc/src/platforms/qt-embedded-linux.qdoc |  2 +-
 src/corelib/global/qglobal.cpp           |  1 +
 src/corelib/global/qnamespace.qdoc       |  6 ++++++
 src/corelib/io/qprocess.cpp              |  2 +-
 src/corelib/tools/qbytearray.cpp         |  4 ++++
 src/corelib/tools/qlocale.cpp            |  3 +++
 src/corelib/tools/qscopedpointer.cpp     |  4 ++++
 src/gui/effects/qgraphicseffect.cpp      |  3 ++-
 src/gui/image/qbitmap.cpp                |  4 +++-
 src/gui/image/qicon.cpp                  | 18 +++++++++---------
 src/gui/inputmethod/qinputcontext.cpp    |  2 +-
 src/gui/kernel/qaction.cpp               | 20 ++++++++++++++++++++
 src/gui/kernel/qgesture.cpp              | 23 ++++++++++++-----------
 src/gui/styles/qstyle.cpp                |  2 +-
 src/script/api/qscriptengine.cpp         | 19 +++++++++----------
 17 files changed, 80 insertions(+), 39 deletions(-)

diff --git a/doc/src/platforms/emb-deployment.qdoc b/doc/src/platforms/emb-deployment.qdoc
index a6fb978..57df026 100644
--- a/doc/src/platforms/emb-deployment.qdoc
+++ b/doc/src/platforms/emb-deployment.qdoc
@@ -71,8 +71,8 @@
     Note that the application will look for the \c /lib/fonts/
     directory relative to the path set using the \c -prefix parameter
     when running the \c configure script; ensure that this is a
-    sensible path in the target device environment. See the \l
-    {Installing Qt for Embedded Linux#Step 3: Building the
+    sensible path in the target device environment. See the 
+    \l {Installing Qt on Embedded Linux#Step 3: Building the
     Library}{installation} documentation for more details.
 
     \section1 Environment Variables
diff --git a/doc/src/platforms/emb-running.qdoc b/doc/src/platforms/emb-running.qdoc
index 67c9283..8f56a3b 100644
--- a/doc/src/platforms/emb-running.qdoc
+++ b/doc/src/platforms/emb-running.qdoc
@@ -77,7 +77,7 @@
     \row
     \o
     Provided that the environment variables are adjusted properly
-    during the \l {Installing Qt for Embedded Linux}{installation process}, you
+    during the \l {Installing Qt on Embedded Linux}{installation process}, you
     should see the \l {Text Edit} demo appear.
 
     It might be that the hardware drivers must be specified explicitly
diff --git a/doc/src/platforms/qt-embedded-linux.qdoc b/doc/src/platforms/qt-embedded-linux.qdoc
index 0bb2f7d..be98e43 100644
--- a/doc/src/platforms/qt-embedded-linux.qdoc
+++ b/doc/src/platforms/qt-embedded-linux.qdoc
@@ -81,7 +81,7 @@
     \o
      \list
         \o \l {Qt for Embedded Linux Architecture}{Architecture Overview}
-        \o \l {Installing Qt for Embedded Linux}{Installation}
+        \o \l {Installing Qt on Embedded Linux}{Installation}
         \o \l {Running Qt for Embedded Linux Applications}{Running Applications}
         \o \l {Qt for Embedded Linux Examples}{Examples}
     \endlist
diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp
index 935c99b..787eba7 100644
--- a/src/corelib/global/qglobal.cpp
+++ b/src/corelib/global/qglobal.cpp
@@ -1189,6 +1189,7 @@ bool qSharedBuild()
     \value SV_S60_3_2 S60 3rd Edition Feature Pack 2
     \value SV_S60_5_0 S60 5th Edition
     \value SV_S60_Unknown An unknown and currently unsupported platform
+    \omitvalue SV_S60_None
 
     \sa SymbianVersion, WinVersion, MacVersion
 */
diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc
index ace70ff..1a0b3e6 100644
--- a/src/corelib/global/qnamespace.qdoc
+++ b/src/corelib/global/qnamespace.qdoc
@@ -612,6 +612,12 @@
 */
 
 /*!
+  \enum Qt::CoordinateSystem 
+  \value DeviceCoordinates
+  \value LogicalCoordinates
+ */
+
+/*!
     \enum Qt::CaseSensitivity
 
     \value CaseInsensitive
diff --git a/src/corelib/io/qprocess.cpp b/src/corelib/io/qprocess.cpp
index 5b6830c..1e3b6eb 100644
--- a/src/corelib/io/qprocess.cpp
+++ b/src/corelib/io/qprocess.cpp
@@ -1572,7 +1572,7 @@ void QProcess::setProcessEnvironment(const QProcessEnvironment &environment)
     \note The environment settings are ignored on Windows CE,
     as there is no concept of an environment.
 
-    \sa setProcessEnvironment(), setEnvironment(), QProcessEnvironment::isValid()
+    \sa setProcessEnvironment(), setEnvironment(), QProcessEnvironment::isEmpty()
 */
 QProcessEnvironment QProcess::processEnvironment() const
 {
diff --git a/src/corelib/tools/qbytearray.cpp b/src/corelib/tools/qbytearray.cpp
index 840f6a5..611fc58 100644
--- a/src/corelib/tools/qbytearray.cpp
+++ b/src/corelib/tools/qbytearray.cpp
@@ -4099,6 +4099,10 @@ QByteArray QByteArray::toPercentEncoding(const QByteArray &exclude, const QByteA
     \internal
 */
 
+/*! \typedef QByteArray::value_type
+  \internal
+ */
+
 /*!
     \fn QByteArray::QByteArray(int size)
 
diff --git a/src/corelib/tools/qlocale.cpp b/src/corelib/tools/qlocale.cpp
index ded36c2..623d63e 100644
--- a/src/corelib/tools/qlocale.cpp
+++ b/src/corelib/tools/qlocale.cpp
@@ -636,6 +636,9 @@ static QString winSystemPMText()
     return QString();
 }
 
+/*!
+  Returns the fallback locale obtained from the system.
+ */
 QLocale QSystemLocale::fallbackLocale() const
 {
     return QLocale(QString::fromLatin1(getWinLocaleName()));
diff --git a/src/corelib/tools/qscopedpointer.cpp b/src/corelib/tools/qscopedpointer.cpp
index 44238a8..7dcac71 100644
--- a/src/corelib/tools/qscopedpointer.cpp
+++ b/src/corelib/tools/qscopedpointer.cpp
@@ -219,4 +219,8 @@ QT_BEGIN_NAMESPACE
     \sa isNull()
 */
 
+/*! \fn void QScopedPointer::swap(QScopedPointer<T, Cleanup> &other)
+  Swap this pointer with \a other.
+ */
+
 QT_END_NAMESPACE
diff --git a/src/gui/effects/qgraphicseffect.cpp b/src/gui/effects/qgraphicseffect.cpp
index f60e80e..6629a6d 100644
--- a/src/gui/effects/qgraphicseffect.cpp
+++ b/src/gui/effects/qgraphicseffect.cpp
@@ -256,7 +256,8 @@ QPixmap QGraphicsEffectSource::pixmap(Qt::CoordinateSystem system, QPoint *offse
 }
 
 /*!
-    Constructs a new QGraphicsEffect instance.
+    Constructs a new QGraphicsEffect instance having the
+    specified \a parent.
 */
 QGraphicsEffect::QGraphicsEffect(QObject *parent)
     : QObject(*new QGraphicsEffectPrivate, parent)
diff --git a/src/gui/image/qbitmap.cpp b/src/gui/image/qbitmap.cpp
index 8c3b9be..b5ffeed 100644
--- a/src/gui/image/qbitmap.cpp
+++ b/src/gui/image/qbitmap.cpp
@@ -92,13 +92,15 @@ QT_BEGIN_NAMESPACE
     \sa  QPixmap, QImage, QImageReader, QImageWriter
 */
 
+/*! \typedef QBitmap::DataPtr
+  \internal
+ */
 
 /*!
     Constructs a null bitmap.
 
     \sa QPixmap::isNull()
 */
-
 QBitmap::QBitmap()
     : QPixmap(QSize(0, 0), QPixmapData::BitmapType)
 {
diff --git a/src/gui/image/qicon.cpp b/src/gui/image/qicon.cpp
index e23677f..1140cd8 100644
--- a/src/gui/image/qicon.cpp
+++ b/src/gui/image/qicon.cpp
@@ -879,20 +879,20 @@ void QIcon::setThemeSearchPaths(const QStringList &paths)
 }
 
 /*!
-    \since 4.6
+  \since 4.6
 
-    Returns the search paths for icon themes.
+  Returns the search paths for icon themes.
 
-    The default value will depend on the platform:
+  The default value will depend on the platform:
 
-    On X11, the search path will use the XDG_DATA_DIRS environment
-    variable if available.
+  On X11, the search path will use the XDG_DATA_DIRS environment
+  variable if available.
 
-    By default all platforms will have the resource directory
-    ":\icons" as their fallback. You can use "rcc -project"
-    to generate a resource file from your icon theme.
+  By default all platforms will have the resource directory
+  \c{:\icons} as a fallback. You can use "rcc -project" to generate a
+  resource file from your icon theme.
 
-    \sa setThemeSearchPaths(), fromTheme(), setThemeName()
+  \sa setThemeSearchPaths(), fromTheme(), setThemeName()
 */
 QStringList QIcon::themeSearchPaths()
 {
diff --git a/src/gui/inputmethod/qinputcontext.cpp b/src/gui/inputmethod/qinputcontext.cpp
index 2422355..ed30810 100644
--- a/src/gui/inputmethod/qinputcontext.cpp
+++ b/src/gui/inputmethod/qinputcontext.cpp
@@ -176,7 +176,7 @@ QWidget *QInputContext::focusWidget() const
 
 
 /*!
-    Sets the widget that has an input focus for this input context.
+    Sets the \a widget that has an input focus for this input context.
 
     \warning Ordinary input methods must not call this function
     directly.
diff --git a/src/gui/kernel/qaction.cpp b/src/gui/kernel/qaction.cpp
index d2a25fd..2a28c71 100644
--- a/src/gui/kernel/qaction.cpp
+++ b/src/gui/kernel/qaction.cpp
@@ -269,6 +269,26 @@ void QActionPrivate::setShortcutEnabled(bool enable, QShortcutMap &map)
     MenuRole for the actions in that submenu have no effect. They will never be moved.
 */
 
+/*! \enum QAction::SoftKeyRole
+  \value OptionsSoftKey
+  \value SelectSoftKey
+  \value BackSoftKey
+  \value NextSoftKey
+  \value PreviousSoftKey
+  \value OkSoftKey
+  \value CancelSoftKey
+  \value EditSoftKey
+  \value ViewSoftKey
+  \value BackSpaceSoftKey
+  \value EndEditSoftKey
+  \value RevertEditSoftKey
+  \value DeselectSoftKey
+  \value FinishSoftKey
+  \value MenuSoftKey
+  \value ContextMenuSoftKey
+  \value ExitSoftKey
+ */
+
 /*!
     Constructs an action with \a parent. If \a parent is an action
     group the action will be automatically inserted into the group.
diff --git a/src/gui/kernel/qgesture.cpp b/src/gui/kernel/qgesture.cpp
index d5e7167..bd37f68 100644
--- a/src/gui/kernel/qgesture.cpp
+++ b/src/gui/kernel/qgesture.cpp
@@ -133,21 +133,22 @@ private:
 
 /*! \fn void QGesture::cancelled()
 
-    The signal is emitted when the gesture is cancelled, for example the reset()
-    function is called while the gesture was in the process of emitting a
-    triggered() signal.  Extended information about the gesture is contained in
-    the sender object.
+  The signal is emitted when the gesture is cancelled, for example the
+  reset() function is called while the gesture was in the process of
+  emitting a triggered() signal.  Extended information about the
+  gesture is contained in the sender object.
 */
 
-
 /*!
-    Creates a new gesture handler object and marks it as a child of \a parent.
+  Creates a new gesture handler object and marks it as a child of \a
+  parent.  \a gestureTarget is the object that the gesture will watch
+  for events.
 
-    The \a parent object is also the default event source for the gesture,
-    meaning that the gesture installs itself as an event filter for the \a
-    parent.
+  The \a parent object is also the default event source for the
+  gesture, meaning that the gesture installs itself as an event filter
+  for the \a parent.
 
-    \sa setGraphicsItem()
+  \sa setGraphicsItem()
 */
 QGesture::QGesture(QObject *gestureTarget, QObject *parent)
     : QObject(*new QGesturePrivate, parent)
@@ -173,7 +174,7 @@ QGesture::~QGesture()
 /*!
     \property QGesture::gestureTarget
 
-    Gesture target is the object that the gesture will observe for events.
+    Gesture target is the object that the gesture will watch for events.
     Typically this means that the gesture installs an event filter on the
     target object.
 */
diff --git a/src/gui/styles/qstyle.cpp b/src/gui/styles/qstyle.cpp
index 0500bff..a5d524c 100644
--- a/src/gui/styles/qstyle.cpp
+++ b/src/gui/styles/qstyle.cpp
@@ -1897,7 +1897,7 @@ void QStyle::drawItemPixmap(QPainter *painter, const QRect &rect, int alignment,
     Returns an integer representing the specified style \a hint for
     the given \a widget described by the provided style \a option.
 
-    \c returnData is used when the querying widget needs more detailed data than
+    \a returnData is used when the querying widget needs more detailed data than
     the integer that styleHint() returns. See the QStyleHintReturn class
     description for details.
 */
diff --git a/src/script/api/qscriptengine.cpp b/src/script/api/qscriptengine.cpp
index 3ffc9c5..359d1e6 100644
--- a/src/script/api/qscriptengine.cpp
+++ b/src/script/api/qscriptengine.cpp
@@ -3236,11 +3236,10 @@ QStringList QScriptEngine::importedExtensions() const
     The \c Container type must provide a \c const_iterator class to enable the
     contents of the container to be copied into the array.
 
-    Additionally, the type of each element in the sequence should be suitable
-    for conversion to a QScriptValue.
-    See \l{QtScript Module#Conversion Between QtScript and C++ Types}
-    {Conversion Between QtScript and C++ Types} for more information about the
-    restrictions on types that can be used with QScriptValue.
+    Additionally, the type of each element in the sequence should be
+    suitable for conversion to a QScriptValue.  See
+    \l{Conversion Between QtScript and C++ Types} for more information
+    about the restrictions on types that can be used with QScriptValue.
 
     \sa qScriptValueFromValue()
 */
@@ -3257,11 +3256,11 @@ QStringList QScriptEngine::importedExtensions() const
     as long as it provides a \c length property describing how many elements
     it contains.
 
-    Additionally, the type of each element in the sequence must be suitable
-    for conversion to a C++ type from a QScriptValue.
-    See \l{QtScript Module#Conversion Between QtScript and C++ Types}
-    {Conversion Between QtScript and C++ Types} for more information about the
-    restrictions on types that can be used with QScriptValue.
+    Additionally, the type of each element in the sequence must be
+    suitable for conversion to a C++ type from a QScriptValue.  See
+    \l{Conversion Between QtScript and C++ Types} for more information
+    about the restrictions on types that can be used with
+    QScriptValue.
 
     \sa qscriptvalue_cast()
 */
-- 
cgit v0.12