From df515ded6096a3c24df7bc9307a12790a6f474e1 Mon Sep 17 00:00:00 2001
From: David Boddie <david.boddie@nokia.com>
Date: Fri, 3 Jun 2011 15:38:44 +0200
Subject: Doc: Fixed qdoc warnings.

Change-Id: I7b4e9ef513b82a82d2365c9256d09520a44ad10d
Reviewed-on: http://codereview.qt.nokia.com/324
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@nokia.com>
---
 src/gui/painting/qpainter.cpp              |  2 ++
 src/gui/text/qglyphrun.cpp                 |  3 ++-
 src/gui/text/qplatformfontdatabase_qpa.cpp | 37 +++++++++++++++++++++++++-----
 3 files changed, 35 insertions(+), 7 deletions(-)

(limited to 'src/gui')

diff --git a/src/gui/painting/qpainter.cpp b/src/gui/painting/qpainter.cpp
index 83bdc5cb30..82e552481c 100644
--- a/src/gui/painting/qpainter.cpp
+++ b/src/gui/painting/qpainter.cpp
@@ -5773,6 +5773,8 @@ void QPainter::drawImage(const QRectF &targetRect, const QImage &image, const QR
 }
 
 /*!
+    \fn void QPainter::drawGlyphRun(const QPointF &position, const QGlyphRun &glyphs)
+
     Draws the glyphs represented by \a glyphs at \a position. The \a position gives the
     edge of the baseline for the string of glyphs. The glyphs will be retrieved from the font
     selected on \a glyphs and at offsets given by the positions in \a glyphs.
diff --git a/src/gui/text/qglyphrun.cpp b/src/gui/text/qglyphrun.cpp
index 18b6357863..cc825525c4 100644
--- a/src/gui/text/qglyphrun.cpp
+++ b/src/gui/text/qglyphrun.cpp
@@ -175,7 +175,8 @@ QRawFont QGlyphRun::rawFont() const
 }
 
 /*!
-    Sets the font in which to look up the glyph indexes to \a font.
+    Sets the font in which to look up the glyph indexes to the \a rawFont
+    specified.
 
     \sa rawFont(), setGlyphIndexes()
 */
diff --git a/src/gui/text/qplatformfontdatabase_qpa.cpp b/src/gui/text/qplatformfontdatabase_qpa.cpp
index 7e829dbd3f..059dc3e188 100644
--- a/src/gui/text/qplatformfontdatabase_qpa.cpp
+++ b/src/gui/text/qplatformfontdatabase_qpa.cpp
@@ -52,7 +52,7 @@ extern void qt_registerFont(const QString &familyname, const QString &foundrynam
                                          const QSupportedWritingSystems &writingSystems, void *hanlde);
 
 /*!
-    \fn void QPlatformFontDatabase::registerQPF2Font(const QByteArray &dataArray, void *)
+    \fn void QPlatformFontDatabase::registerQPF2Font(const QByteArray &dataArray, void *handle)
 
     Registers the pre-rendered QPF2 font contained in the given \a dataArray.
 
@@ -149,17 +149,26 @@ public:
     QVector<bool> vector;
 };
 
+/*!
+    Constructs a new object to handle supported writing systems.
+*/
 QSupportedWritingSystems::QSupportedWritingSystems()
 {
     d = new QWritingSystemsPrivate;
 }
 
+/*!
+    Constructs a copy of the \a other writing systems object.
+*/
 QSupportedWritingSystems::QSupportedWritingSystems(const QSupportedWritingSystems &other)
 {
     d = other.d;
     d->ref.ref();
 }
 
+/*!
+    Constructs a copy of the \a other writing systems object.
+*/
 QSupportedWritingSystems &QSupportedWritingSystems::operator=(const QSupportedWritingSystems &other)
 {
     if (d != other.d) {
@@ -171,12 +180,18 @@ QSupportedWritingSystems &QSupportedWritingSystems::operator=(const QSupportedWr
     return *this;
 }
 
+/*!
+    Destroys the supported writing systems object.
+*/
 QSupportedWritingSystems::~QSupportedWritingSystems()
 {
     if (!d->ref.deref())
         delete d;
 }
 
+/*!
+    \internal
+*/
 void QSupportedWritingSystems::detach()
 {
     if (d->ref != 1) {
@@ -187,12 +202,20 @@ void QSupportedWritingSystems::detach()
     }
 }
 
+/*!
+    Sets or clears support for the specified \a writingSystem based on the
+    value given by \a support.
+*/
 void QSupportedWritingSystems::setSupported(QFontDatabase::WritingSystem writingSystem, bool support)
 {
     detach();
     d->vector[writingSystem] = support;
 }
 
+/*!
+    Returns true if the writing system specified by \a writingSystem is
+    supported; otherwise returns false.
+*/
 bool QSupportedWritingSystems::supported(QFontDatabase::WritingSystem writingSystem) const
 {
     return d->vector.at(writingSystem);
@@ -210,10 +233,12 @@ bool QSupportedWritingSystems::supported(QFontDatabase::WritingSystem writingSys
 */
 
 /*!
-  This function is called once at startup by Qts internal fontdatabase. Reimplement this function
-  in a subclass for a convenient place to initialise the internal fontdatabase.
+  This function is called once at startup by Qt's internal font database.
+  Reimplement this function in a subclass for a convenient place to initialize
+  the internal font database.
 
-  The default implementation looks in the fontDir() location and registers all qpf2 fonts.
+  The default implementation looks in the fontDir() location and registers all
+  QPF2 fonts.
 */
 void QPlatformFontDatabase::populateFontDatabase()
 {
@@ -294,7 +319,7 @@ QStringList QPlatformFontDatabase::addApplicationFont(const QByteArray &fontData
 }
 
 /*!
-
+    Releases the specified font \a handle.
 */
 void QPlatformFontDatabase::releaseHandle(void *handle)
 {
@@ -303,7 +328,7 @@ void QPlatformFontDatabase::releaseHandle(void *handle)
 }
 
 /*!
-
+    Returns the directory containing the fonts used by the database.
 */
 QString QPlatformFontDatabase::fontDir() const
 {
-- 
cgit v1.2.3