From 4533cc994484a2308297e64e99af005fb4dca065 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 2 Oct 2013 16:51:05 +0200 Subject: 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 Reviewed-by: Jerome Pasion --- src/corelib/itemmodels/qsortfilterproxymodel.cpp | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'src/corelib/itemmodels/qsortfilterproxymodel.cpp') diff --git a/src/corelib/itemmodels/qsortfilterproxymodel.cpp b/src/corelib/itemmodels/qsortfilterproxymodel.cpp index 67b0d98402..63e0374740 100644 --- a/src/corelib/itemmodels/qsortfilterproxymodel.cpp +++ b/src/corelib/itemmodels/qsortfilterproxymodel.cpp @@ -2587,9 +2587,9 @@ void QSortFilterProxyModel::invalidateFilter() } /*! - Returns true if the value of the item referred to by the given + Returns \c true if the value of the item referred to by the given index \a left is less than the value of the item referred to by - the given index \a right, otherwise returns false. + the given index \a right, otherwise returns \c false. This function is used as the < operator when sorting, and handles the following QVariant types: @@ -2661,11 +2661,11 @@ bool QSortFilterProxyModel::lessThan(const QModelIndex &left, const QModelIndex } /*! - Returns true if the item in the row indicated by the given \a source_row + Returns \c true if the item in the row indicated by the given \a source_row and \a source_parent should be included in the model; otherwise returns false. - The default implementation returns true if the value held by the relevant item + The default implementation returns \c true if the value held by the relevant item matches the filter string, wildcard string or regular expression. \note By default, the Qt::DisplayRole is used to determine if the row @@ -2697,10 +2697,10 @@ bool QSortFilterProxyModel::filterAcceptsRow(int source_row, const QModelIndex & } /*! - Returns true if the item in the column indicated by the given \a source_column - and \a source_parent should be included in the model; otherwise returns false. + Returns \c true if the item in the column indicated by the given \a source_column + and \a source_parent should be included in the model; otherwise returns \c false. - The default implementation returns true if the value held by the relevant item + The default implementation returns \c true if the value held by the relevant item matches the filter string, wildcard string or regular expression. \note By default, the Qt::DisplayRole is used to determine if the row -- cgit v1.2.3