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/widgets/styles | |
parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff) | |
download | qtbase-4533cc994484a2308297e64e99af005fb4dca065.tar.gz |
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/widgets/styles')
-rw-r--r-- | src/widgets/styles/qstylepainter.cpp | 2 | ||||
-rw-r--r-- | src/widgets/styles/qstylesheetstyle.cpp | 4 | ||||
-rw-r--r-- | src/widgets/styles/qwindowsstyle.cpp | 2 | ||||
-rw-r--r-- | src/widgets/styles/qwindowsvistastyle.cpp | 2 | ||||
-rw-r--r-- | src/widgets/styles/qwindowsxpstyle.cpp | 8 |
5 files changed, 9 insertions, 9 deletions
diff --git a/src/widgets/styles/qstylepainter.cpp b/src/widgets/styles/qstylepainter.cpp index 5c2c44b45b..bc1fe748a8 100644 --- a/src/widgets/styles/qstylepainter.cpp +++ b/src/widgets/styles/qstylepainter.cpp @@ -100,7 +100,7 @@ QT_BEGIN_NAMESPACE \fn bool QStylePainter::begin(QWidget *widget) Begin painting operations on the specified \a widget. - Returns true if the painter is ready to use; otherwise returns false. + Returns \c true if the painter is ready to use; otherwise returns \c false. This is automatically called by the constructor that takes a QWidget. */ diff --git a/src/widgets/styles/qstylesheetstyle.cpp b/src/widgets/styles/qstylesheetstyle.cpp index 85520d3c40..417e092e11 100644 --- a/src/widgets/styles/qstylesheetstyle.cpp +++ b/src/widgets/styles/qstylesheetstyle.cpp @@ -2379,7 +2379,7 @@ static QWidget *containerWidget(const QWidget *w) } /** \internal - returns true if the widget can NOT be styled directly + returns \c true if the widget can NOT be styled directly */ static bool unstylable(const QWidget *w) { @@ -5840,7 +5840,7 @@ void QStyleSheetStyle::clearWidgetFont(QWidget* w) const // Polish palette that should be used for a particular widget, with particular states // (eg. :focus, :hover, ...) // this is called by widgets that paint themself in their paint event -// Returns true if there is a new palette in pal. +// Returns \c true if there is a new palette in pal. bool QStyleSheetStyle::styleSheetPalette(const QWidget* w, const QStyleOption* opt, QPalette* pal) { if (!w || !opt || !pal) diff --git a/src/widgets/styles/qwindowsstyle.cpp b/src/widgets/styles/qwindowsstyle.cpp index b153d05885..dde705f9b9 100644 --- a/src/widgets/styles/qwindowsstyle.cpp +++ b/src/widgets/styles/qwindowsstyle.cpp @@ -130,7 +130,7 @@ QWindowsStylePrivate::QWindowsStylePrivate() #endif } -// Returns true if the toplevel parent of \a widget has seen the Alt-key +// Returns \c true if the toplevel parent of \a widget has seen the Alt-key bool QWindowsStylePrivate::hasSeenAlt(const QWidget *widget) const { widget = widget->window(); diff --git a/src/widgets/styles/qwindowsvistastyle.cpp b/src/widgets/styles/qwindowsvistastyle.cpp index 22458eb96f..2f36944b5e 100644 --- a/src/widgets/styles/qwindowsvistastyle.cpp +++ b/src/widgets/styles/qwindowsvistastyle.cpp @@ -2502,7 +2502,7 @@ bool QWindowsVistaStylePrivate::transitionsEnabled() const } /*! \internal - Returns true if all the necessary theme engine symbols were + Returns \c true if all the necessary theme engine symbols were resolved. */ bool QWindowsVistaStylePrivate::resolveSymbols() diff --git a/src/widgets/styles/qwindowsxpstyle.cpp b/src/widgets/styles/qwindowsxpstyle.cpp index 506a148d2f..63ed3ef7c8 100644 --- a/src/widgets/styles/qwindowsxpstyle.cpp +++ b/src/widgets/styles/qwindowsxpstyle.cpp @@ -169,7 +169,7 @@ static inline HDC hdcForWidgetBackingStore(const QWidget *widget) // Theme data helper ------------------------------------------------------------------------------ /* \internal - Returns true if the themedata is valid for use. + Returns \c true if the themedata is valid for use. */ bool XPThemeData::isValid() { @@ -399,7 +399,7 @@ const QPixmap *QWindowsXPStylePrivate::tabBody(QWidget *) } /*! \internal - Returns true if all the necessary theme engine symbols were + Returns \c true if all the necessary theme engine symbols were resolved. */ bool QWindowsXPStylePrivate::resolveSymbols() @@ -501,7 +501,7 @@ HBITMAP QWindowsXPStylePrivate::buffer(int w, int h) } /*! \internal - Returns true if the part contains any transparency at all. This does + Returns \c true if the part contains any transparency at all. This does not indicate what kind of transparency we're dealing with. It can be - Alpha transparency - Masked transparency @@ -572,7 +572,7 @@ void QWindowsXPStylePrivate::setTransparency(QWidget *widget, XPThemeData &theme } /*! \internal - Returns true if the native doublebuffer contains pixels with + Returns \c true if the native doublebuffer contains pixels with varying alpha value. */ bool QWindowsXPStylePrivate::hasAlphaChannel(const QRect &rect) |