summaryrefslogtreecommitdiffstats
path: root/src/corelib/itemmodels/qitemselectionmodel.cpp
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/itemmodels/qitemselectionmodel.cpp
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/corelib/itemmodels/qitemselectionmodel.cpp')
-rw-r--r--src/corelib/itemmodels/qitemselectionmodel.cpp46
1 files changed, 23 insertions, 23 deletions
diff --git a/src/corelib/itemmodels/qitemselectionmodel.cpp b/src/corelib/itemmodels/qitemselectionmodel.cpp
index ea4d9b44c3..aff9939b87 100644
--- a/src/corelib/itemmodels/qitemselectionmodel.cpp
+++ b/src/corelib/itemmodels/qitemselectionmodel.cpp
@@ -190,8 +190,8 @@ QT_BEGIN_NAMESPACE
/*!
\fn bool QItemSelectionRange::contains(const QModelIndex &index) const
- Returns true if the model item specified by the \a index lies within the
- range of selected items; otherwise returns false.
+ Returns \c true if the model item specified by the \a index lies within the
+ range of selected items; otherwise returns \c false.
*/
/*!
@@ -199,16 +199,16 @@ QT_BEGIN_NAMESPACE
const QModelIndex &parentIndex) const
\overload
- Returns true if the model item specified by (\a row, \a column)
+ Returns \c true if the model item specified by (\a row, \a column)
and with \a parentIndex as the parent item lies within the range
- of selected items; otherwise returns false.
+ of selected items; otherwise returns \c false.
*/
/*!
\fn bool QItemSelectionRange::intersects(const QItemSelectionRange &other) const
- Returns true if this selection range intersects (overlaps with) the \a other
- range given; otherwise returns false.
+ Returns \c true if this selection range intersects (overlaps with) the \a other
+ range given; otherwise returns \c false.
*/
bool QItemSelectionRange::intersects(const QItemSelectionRange &other) const
@@ -254,24 +254,24 @@ QItemSelectionRange QItemSelectionRange::intersected(const QItemSelectionRange &
/*!
\fn bool QItemSelectionRange::operator==(const QItemSelectionRange &other) const
- Returns true if the selection range is exactly the same as the \a other
- range given; otherwise returns false.
+ Returns \c true if the selection range is exactly the same as the \a other
+ range given; otherwise returns \c false.
*/
/*!
\fn bool QItemSelectionRange::operator!=(const QItemSelectionRange &other) const
- Returns true if the selection range differs from the \a other range given;
- otherwise returns false.
+ Returns \c true if the selection range differs from the \a other range given;
+ otherwise returns \c false.
*/
/*!
\fn bool QItemSelectionRange::operator<(const QItemSelectionRange &other) const
- Returns true if the selection range is less than the \a other
- range given; otherwise returns false.
+ Returns \c true if the selection range is less than the \a other
+ range given; otherwise returns \c false.
The less than calculation is not directly useful to developers - the way that ranges
with different parents compare is not defined. This operator only exists so that the
@@ -282,7 +282,7 @@ QItemSelectionRange QItemSelectionRange::intersected(const QItemSelectionRange &
/*!
\fn bool QItemSelectionRange::isValid() const
- Returns true if the selection range is valid; otherwise returns false.
+ Returns \c true if the selection range is valid; otherwise returns \c false.
*/
@@ -322,7 +322,7 @@ static void indexesFromRange(const QItemSelectionRange &range, ModelIndexContain
}
/*!
- Returns true if the selection range contains no selectable item
+ Returns \c true if the selection range contains no selectable item
\since 4.7
*/
@@ -442,8 +442,8 @@ void QItemSelection::select(const QModelIndex &topLeft, const QModelIndex &botto
}
/*!
- Returns true if the selection contains the given \a index; otherwise
- returns false.
+ Returns \c true if the selection contains the given \a index; otherwise
+ returns \c false.
*/
bool QItemSelection::contains(const QModelIndex &index) const
@@ -1331,7 +1331,7 @@ QModelIndex QItemSelectionModel::currentIndex() const
}
/*!
- Returns true if the given model item \a index is selected.
+ Returns \c true if the given model item \a index is selected.
*/
bool QItemSelectionModel::isSelected(const QModelIndex &index) const
{
@@ -1368,7 +1368,7 @@ bool QItemSelectionModel::isSelected(const QModelIndex &index) const
}
/*!
- Returns true if all items are selected in the \a row with the given
+ Returns \c true if all items are selected in the \a row with the given
\a parent.
Note that this function is usually faster than calling isSelected()
@@ -1428,7 +1428,7 @@ bool QItemSelectionModel::isRowSelected(int row, const QModelIndex &parent) cons
}
/*!
- Returns true if all items are selected in the \a column with the given
+ Returns \c true if all items are selected in the \a column with the given
\a parent.
Note that this function is usually faster than calling isSelected()
@@ -1488,7 +1488,7 @@ bool QItemSelectionModel::isColumnSelected(int column, const QModelIndex &parent
}
/*!
- Returns true if there are any items selected in the \a row with the given
+ Returns \c true if there are any items selected in the \a row with the given
\a parent.
*/
bool QItemSelectionModel::rowIntersectsSelection(int row, const QModelIndex &parent) const
@@ -1520,7 +1520,7 @@ bool QItemSelectionModel::rowIntersectsSelection(int row, const QModelIndex &par
}
/*!
- Returns true if there are any items selected in the \a column with the given
+ Returns \c true if there are any items selected in the \a column with the given
\a parent.
*/
bool QItemSelectionModel::columnIntersectsSelection(int column, const QModelIndex &parent) const
@@ -1551,8 +1551,8 @@ bool QItemSelectionModel::columnIntersectsSelection(int column, const QModelInde
/*!
\since 4.2
- Returns true if the selection model contains any selection ranges;
- otherwise returns false.
+ Returns \c true if the selection model contains any selection ranges;
+ otherwise returns \c false.
*/
bool QItemSelectionModel::hasSelection() const
{