diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:51:05 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-08 00:46:27 +0200 |
commit | 4533cc994484a2308297e64e99af005fb4dca065 (patch) | |
tree | bc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/plugins/platforms | |
parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff) |
Doc: Adding mark-up to boolean default values.
Default values should have mark-up to denote that they are code.
This commit changes:
-"property is true" to "property is \c true".
-"Returns true" to "Returns \c true".
-"property is false" to "property is \c false".
-"returns true" to "returns \c true".
-"returns false" to "returns \c false".
src/3rdparty and non-documentation instances were ignored.
Task-number: QTBUG-33360
Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/plugins/platforms')
-rw-r--r-- | src/plugins/platforms/cocoa/qmacmime.mm | 4 | ||||
-rw-r--r-- | src/plugins/platforms/ios/qiosglobal.mm | 2 | ||||
-rw-r--r-- | src/plugins/platforms/windows/qwindowsmime.cpp | 4 | ||||
-rw-r--r-- | src/plugins/platforms/xcb/qxcbwindow.cpp | 2 |
4 files changed, 6 insertions, 6 deletions
diff --git a/src/plugins/platforms/cocoa/qmacmime.mm b/src/plugins/platforms/cocoa/qmacmime.mm index 51c39357ea..b4634c8ad8 100644 --- a/src/plugins/platforms/cocoa/qmacmime.mm +++ b/src/plugins/platforms/cocoa/qmacmime.mm @@ -914,8 +914,8 @@ QList<QMacPasteboardMime*> QMacPasteboardMime::all(uchar t) /*! \fn bool QMacPasteboardMime::canConvert(const QString &mime, QString flav) - Returns true if the convertor can convert (both ways) between - \a mime and \a flav; otherwise returns false. + Returns \c true if the convertor can convert (both ways) between + \a mime and \a flav; otherwise returns \c false. All subclasses must reimplement this pure virtual function. */ diff --git a/src/plugins/platforms/ios/qiosglobal.mm b/src/plugins/platforms/ios/qiosglobal.mm index 537d63ae77..9b8462a6cc 100644 --- a/src/plugins/platforms/ios/qiosglobal.mm +++ b/src/plugins/platforms/ios/qiosglobal.mm @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE bool isQtApplication() { - // Returns true if the plugin is in full control of the whole application. This means + // Returns \c true if the plugin is in full control of the whole application. This means // that we control the application delegate and the top view controller, and can take // actions that impacts all parts of the application. The opposite means that we are // embedded inside a native iOS application, and should be more focused on playing along diff --git a/src/plugins/platforms/windows/qwindowsmime.cpp b/src/plugins/platforms/windows/qwindowsmime.cpp index c1d75c2ad0..f62b8a6139 100644 --- a/src/plugins/platforms/windows/qwindowsmime.cpp +++ b/src/plugins/platforms/windows/qwindowsmime.cpp @@ -469,7 +469,7 @@ int QWindowsMime::registerMimeType(const QString &mime) /*! \fn bool QWindowsMime::canConvertFromMime(const FORMATETC &formatetc, const QMimeData *mimeData) const - Returns true if the converter can convert from the \a mimeData to + Returns \c true if the converter can convert from the \a mimeData to the format specified in \a formatetc. All subclasses must reimplement this pure virtual function. @@ -478,7 +478,7 @@ int QWindowsMime::registerMimeType(const QString &mime) /*! \fn bool QWindowsMime::canConvertToMime(const QString &mimeType, IDataObject *pDataObj) const - Returns true if the converter can convert to the \a mimeType from + Returns \c true if the converter can convert to the \a mimeType from the available formats in \a pDataObj. All subclasses must reimplement this pure virtual function. diff --git a/src/plugins/platforms/xcb/qxcbwindow.cpp b/src/plugins/platforms/xcb/qxcbwindow.cpp index 1f5169e8d9..a0192510ee 100644 --- a/src/plugins/platforms/xcb/qxcbwindow.cpp +++ b/src/plugins/platforms/xcb/qxcbwindow.cpp @@ -156,7 +156,7 @@ enum QX11EmbedMessageType { const long XEMBED_VERSION = 0; -// Returns true if we should set WM_TRANSIENT_FOR on \a w +// Returns \c true if we should set WM_TRANSIENT_FOR on \a w static inline bool isTransient(const QWindow *w) { return w->type() == Qt::Dialog |