From df515ded6096a3c24df7bc9307a12790a6f474e1 Mon Sep 17 00:00:00 2001 From: David Boddie Date: Fri, 3 Jun 2011 15:38:44 +0200 Subject: [PATCH] Doc: Fixed qdoc warnings. Change-Id: I7b4e9ef513b82a82d2365c9256d09520a44ad10d Reviewed-on: http://codereview.qt.nokia.com/324 Reviewed-by: Qt Sanity Bot Reviewed-by: Eskil Abrahamsen Blomfeldt --- src/corelib/io/qdatastream.cpp | 2 ++ src/corelib/io/qfile.cpp | 8 ++++--- src/corelib/io/qnoncontiguousbytedevice.cpp | 8 +++---- src/gui/painting/qpainter.cpp | 2 ++ src/gui/text/qglyphrun.cpp | 3 ++- src/gui/text/qplatformfontdatabase_qpa.cpp | 37 ++++++++++++++++++++++++----- src/network/access/qnetworkrequest.cpp | 25 +++++++++++-------- src/network/kernel/qnetworkproxy.cpp | 7 +++++- 8 files changed, 67 insertions(+), 25 deletions(-) diff --git a/src/corelib/io/qdatastream.cpp b/src/corelib/io/qdatastream.cpp index 9af0cee..af4ec3b 100644 --- a/src/corelib/io/qdatastream.cpp +++ b/src/corelib/io/qdatastream.cpp @@ -562,6 +562,8 @@ void QDataStream::setByteOrder(ByteOrder bo) \value Qt_4_6 Version 12 (Qt 4.6, Qt 4.7, Qt 4.8) \value Qt_4_7 Same as Qt_4_6. \value Qt_4_8 Same as Qt_4_6. + \value Qt_4_9 Same as Qt_4_6. + \value Qt_5_0 Same as Qt_4_6. \sa setVersion(), version() */ diff --git a/src/corelib/io/qfile.cpp b/src/corelib/io/qfile.cpp index 7fb26ad..47f57f7 100644 --- a/src/corelib/io/qfile.cpp +++ b/src/corelib/io/qfile.cpp @@ -364,10 +364,12 @@ QFilePrivate::setError(QFile::FileError err, int errNum) QIODevice. \value AutoCloseHandle The file handle passed into open() should be - closed by close(), the default behaviour is that close just flushes - the file and the app is responsible for closing the file handle. When - opening a file by name, this flag is ignored as Qt always "owns" the + closed by close(), the default behavior is that close just flushes + the file and the application is responsible for closing the file handle. + When opening a file by name, this flag is ignored as Qt always owns the file handle and must close it. + \value DontCloseHandle If not explicitly closed, the underlying file + handle is left open when the QFile object is destroyed. */ #ifdef QT_NO_QOBJECT diff --git a/src/corelib/io/qnoncontiguousbytedevice.cpp b/src/corelib/io/qnoncontiguousbytedevice.cpp index 5568920..113ba4b 100644 --- a/src/corelib/io/qnoncontiguousbytedevice.cpp +++ b/src/corelib/io/qnoncontiguousbytedevice.cpp @@ -479,7 +479,7 @@ qint64 QByteDeviceWrappingIoDevice::writeData( const char* data, qint64 maxSize) */ /*! - \fn static QNonContiguousByteDevice* QNonContiguousByteDeviceFactory::create(QIODevice *device); + \fn static QNonContiguousByteDevice* QNonContiguousByteDeviceFactory::create(QIODevice *device) Create a QNonContiguousByteDevice out of a QIODevice. For QFile, QBuffer and all other QIoDevice, sequential or not. @@ -501,7 +501,7 @@ QNonContiguousByteDevice* QNonContiguousByteDeviceFactory::create(QIODevice *dev } /*! - \fn static QNonContiguousByteDevice* QNonContiguousByteDeviceFactory::create(QRingBuffer *ringBuffer); + \fn static QNonContiguousByteDevice* QNonContiguousByteDeviceFactory::create(QSharedPointer ringBuffer) Create a QNonContiguousByteDevice out of a QRingBuffer. @@ -513,7 +513,7 @@ QNonContiguousByteDevice* QNonContiguousByteDeviceFactory::create(QSharedPointer } /*! - \fn static QNonContiguousByteDevice* QNonContiguousByteDeviceFactory::create(QByteArray *byteArray); + \fn static QNonContiguousByteDevice* QNonContiguousByteDeviceFactory::create(QByteArray *byteArray) Create a QNonContiguousByteDevice out of a QByteArray. @@ -525,7 +525,7 @@ QNonContiguousByteDevice* QNonContiguousByteDeviceFactory::create(QByteArray *by } /*! - \fn static QIODevice* QNonContiguousByteDeviceFactory::wrap(QNonContiguousByteDevice* byteDevice); + \fn static QIODevice* QNonContiguousByteDeviceFactory::wrap(QNonContiguousByteDevice* byteDevice) Wrap the \a byteDevice (possibly again) into a QIODevice. diff --git a/src/gui/painting/qpainter.cpp b/src/gui/painting/qpainter.cpp index 83bdc5c..82e5524 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 18b6357..cc82552 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 7e829db..059dc3e 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 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 { diff --git a/src/network/access/qnetworkrequest.cpp b/src/network/access/qnetworkrequest.cpp index 5608f1f..7f61ef9 100644 --- a/src/network/access/qnetworkrequest.cpp +++ b/src/network/access/qnetworkrequest.cpp @@ -77,28 +77,33 @@ QT_BEGIN_NAMESPACE List of known header types that QNetworkRequest parses. Each known header is also represented in raw form with its full HTTP name. - \value ContentTypeHeader corresponds to the HTTP Content-Type + \value ContentDispositionHeader Corresponds to the HTTP + Content-Disposition header and contains a string containing the + disposition type (for instance, attachment) and a parameter (for + instance, filename). + + \value ContentTypeHeader Corresponds to the HTTP Content-Type header and contains a string containing the media (MIME) type and - any auxiliary data (for instance, charset) + any auxiliary data (for instance, charset). - \value ContentLengthHeader corresponds to the HTTP Content-Length + \value ContentLengthHeader Corresponds to the HTTP Content-Length header and contains the length in bytes of the data transmitted. - \value LocationHeader corresponds to the HTTP Location + \value LocationHeader Corresponds to the HTTP Location header and contains a URL representing the actual location of the data, including the destination URL in case of redirections. - \value LastModifiedHeader corresponds to the HTTP Last-Modified + \value LastModifiedHeader Corresponds to the HTTP Last-Modified header and contains a QDateTime representing the last modification - date of the contents + date of the contents. - \value CookieHeader corresponds to the HTTP Cookie header + \value CookieHeader Corresponds to the HTTP Cookie header and contains a QList representing the cookies to - be sent back to the server + be sent back to the server. - \value SetCookieHeader corresponds to the HTTP Set-Cookie + \value SetCookieHeader Corresponds to the HTTP Set-Cookie header and contains a QList representing the - cookies sent by the server to be stored locally + cookies sent by the server to be stored locally. \sa header(), setHeader(), rawHeader(), setRawHeader() */ diff --git a/src/network/kernel/qnetworkproxy.cpp b/src/network/kernel/qnetworkproxy.cpp index 4f9836e..1062663 100644 --- a/src/network/kernel/qnetworkproxy.cpp +++ b/src/network/kernel/qnetworkproxy.cpp @@ -1191,6 +1191,11 @@ void QNetworkProxyQuery::setUrl(const QUrl &url) } #ifndef QT_NO_BEARERMANAGEMENT +/*! + Returns the network configuration component of the query. + + \sa setNetworkConfiguration() +*/ QNetworkConfiguration QNetworkProxyQuery::networkConfiguration() const { return d ? d->config : QNetworkConfiguration(); @@ -1206,7 +1211,7 @@ QNetworkConfiguration QNetworkProxyQuery::networkConfiguration() const you should first start the QNetworkSession and obtain the active configuration from its properties. - \sa networkConfiguration + \sa networkConfiguration() */ void QNetworkProxyQuery::setNetworkConfiguration(const QNetworkConfiguration &networkConfiguration) { -- 2.7.4