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/kernel/qaction.cpp | |
| 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/widgets/kernel/qaction.cpp')
| -rw-r--r-- | src/widgets/kernel/qaction.cpp | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/widgets/kernel/qaction.cpp b/src/widgets/kernel/qaction.cpp index 267d787116..3e76699aca 100644 --- a/src/widgets/kernel/qaction.cpp +++ b/src/widgets/kernel/qaction.cpp @@ -706,8 +706,8 @@ void QAction::setSeparator(bool b) } /*! - Returns true if this action is a separator action; otherwise it - returns false. + Returns \c true if this action is a separator action; otherwise it + returns \c false. \sa QAction::setSeparator() */ @@ -931,7 +931,7 @@ QAction::Priority QAction::priority() const in a word processor, a Bold toolbar button may be either on or off. An action which is not a toggle action is a command action; a command action is simply executed, e.g. file save. - By default, this property is false. + By default, this property is \c false. In some situations, the state of one toggle action should depend on the state of others. For example, "Left Align", "Center" and @@ -1024,7 +1024,7 @@ bool QAction::isChecked() const action is disabled, it is not possible to trigger it through its shortcut. - By default, this property is true (actions are enabled). + By default, this property is \c true (actions are enabled). \sa text */ @@ -1061,7 +1061,7 @@ bool QAction::isEnabled() const Actions which are not visible are \e not grayed out; they do not appear at all. - By default, this property is true (actions are visible). + By default, this property is \c true (actions are visible). */ void QAction::setVisible(bool b) { @@ -1137,8 +1137,8 @@ QAction::setData(const QVariant &data) /*! Updates the relevant status bar for the \a widget specified by sending a - QStatusTipEvent to its parent widget. Returns true if an event was sent; - otherwise returns false. + QStatusTipEvent to its parent widget. Returns \c true if an event was sent; + otherwise returns \c false. If a null widget is specified, the event is sent to the action's parent. |