From 42d712b4ab7375a97e4095b2a6723305000e194c Mon Sep 17 00:00:00 2001 From: Shawn Rutledge Date: Thu, 16 Aug 2012 18:19:39 +0200 Subject: [PATCH] Misc documentation fixes triggered by qdoc errors/warnings MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Change-Id: I6ca3b138114fe957a09e8ec2f22273865635fc8b Reviewed-by: Jan-Arve Sæther --- src/corelib/io/qurl.cpp | 9 ++++----- src/corelib/kernel/qtranslator.cpp | 6 +++--- src/printsupport/kernel/qprinterinfo.cpp | 25 +++++++++---------------- src/widgets/widgets/qcombobox.cpp | 2 +- 4 files changed, 17 insertions(+), 25 deletions(-) diff --git a/src/corelib/io/qurl.cpp b/src/corelib/io/qurl.cpp index 38a9f1e..25006b1 100644 --- a/src/corelib/io/qurl.cpp +++ b/src/corelib/io/qurl.cpp @@ -1272,7 +1272,7 @@ static void removeDotsFromPath(QString *path) in += 2; break; } - + // otherwise, if the input buffer begins with a prefix // of "/../" or "/..", where ".." is a complete path // segment, then replace that prefix with "/" in the @@ -1295,7 +1295,7 @@ static void removeDotsFromPath(QString *path) in += 3; break; } - + // otherwise move the first path segment in // the input buffer to the end of the output // buffer, including the initial "/" character @@ -3439,12 +3439,11 @@ QString QUrl::errorString() const */ /*! - \relates QHash - \since 5.0 - Returns the hash value for the \a url. If specified, \a seed is used to initialize the hash. + \relates QHash + \since 5.0 */ uint qHash(const QUrl &url, uint seed) { diff --git a/src/corelib/kernel/qtranslator.cpp b/src/corelib/kernel/qtranslator.cpp index 34bc601..fa860f5 100644 --- a/src/corelib/kernel/qtranslator.cpp +++ b/src/corelib/kernel/qtranslator.cpp @@ -431,7 +431,7 @@ QTranslator::~QTranslator() If \a directory is not specified, the directory of the application's executable is used (i.e., as - \l{QCoreApplication::}{applicationDirPath()}). + \l{QCoreApplication::}{applicationDirPath()}). The previous contents of this translator object are discarded. @@ -472,8 +472,8 @@ bool QTranslator::load(const QString & filename, const QString & directory, QString prefix; if (QFileInfo(filename).isRelative()) { prefix = directory; - if (prefix.length() && !prefix.endsWith(QLatin1Char('/'))) - prefix += QLatin1Char('/'); + if (prefix.length() && !prefix.endsWith(QLatin1Char('/'))) + prefix += QLatin1Char('/'); } QString fname = filename; diff --git a/src/printsupport/kernel/qprinterinfo.cpp b/src/printsupport/kernel/qprinterinfo.cpp index 5ce0165..7cef6e6 100644 --- a/src/printsupport/kernel/qprinterinfo.cpp +++ b/src/printsupport/kernel/qprinterinfo.cpp @@ -43,7 +43,7 @@ QPrinterInfoPrivate QPrinterInfoPrivate::shared_null; \brief The QPrinterInfo class gives access to information about existing printers. - + \ingroup printing \inmodule QtPrintSupport @@ -149,11 +149,9 @@ QString QPrinterInfo::printerName() const } /*! - \fn QString QPrinterInfo::description() - \since 5.0 - Returns the human-readable description of the printer. + \since 5.0 \sa QPrinterInfo::printerName() */ QString QPrinterInfo::description() const @@ -163,10 +161,9 @@ QString QPrinterInfo::description() const } /*! - \fn QString QPrinterInfo::location() - \since 5.0 - Returns the human-readable location of the printer. + + \since 5.0 */ QString QPrinterInfo::location() const { @@ -175,10 +172,9 @@ QString QPrinterInfo::location() const } /*! - \fn QString QPrinterInfo::makeAndModel() - \since 5.0 - Returns the human-readable make and model of the printer. + + \since 5.0 */ QString QPrinterInfo::makeAndModel() const { @@ -208,13 +204,12 @@ bool QPrinterInfo::isDefault() const } /*! - \fn QList< QPrinter::PaperSize> QPrinterInfo::supportedPaperSizes() const - \since 4.4 - Returns a list of supported paper sizes by the printer. Not all printer drivers support this query, so the list may be empty. On Mac OS X 10.3, this function always returns an empty list. + + \since 4.4 */ QList QPrinterInfo::supportedPaperSizes() const @@ -244,14 +239,12 @@ QPrinterInfo QPrinterInfo::defaultPrinter() } /*! - \fn QPrinterInfo QPrinterInfo::printerInfo() - \since 5.0 - Returns the named printer. The return value should be checked using isNull() before being used, in case the named printer does not exist. + \since 5.0 \sa isNull() */ diff --git a/src/widgets/widgets/qcombobox.cpp b/src/widgets/widgets/qcombobox.cpp index 82e005e..374cee9 100644 --- a/src/widgets/widgets/qcombobox.cpp +++ b/src/widgets/widgets/qcombobox.cpp @@ -877,7 +877,7 @@ QComboBox::QComboBox(QComboBoxPrivate &dd, QWidget *parent) When the user enters a new string in an editable combobox, the widget may or may not insert it, and it can insert it in several - locations. The default policy is is \l InsertAtBottom but you can change + locations. The default policy is \l InsertAtBottom but you can change this using setInsertPolicy(). It is possible to constrain the input to an editable combobox -- 2.7.4