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/gui/accessible/qaccessible.cpp | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'src/gui/accessible') diff --git a/src/gui/accessible/qaccessible.cpp b/src/gui/accessible/qaccessible.cpp index e7827407f9..b8771ec583 100644 --- a/src/gui/accessible/qaccessible.cpp +++ b/src/gui/accessible/qaccessible.cpp @@ -727,7 +727,7 @@ QAccessibleInterface *QAccessible::accessibleInterface(Id id) /*! - Returns true if the platform requested accessibility information. + Returns \c true if the platform requested accessibility information. This function will return false until a tool such as a screen reader accessed the accessibility framework. It is still possible to use @@ -992,9 +992,9 @@ QPair< int, int > QAccessible::qAccessibleTextBoundaryHelper(const QTextCursor & /*! \fn bool QAccessibleInterface::isValid() const - Returns true if all the data necessary to use this interface + Returns \c true if all the data necessary to use this interface implementation is valid (e.g. all pointers are non-null); - otherwise returns false. + otherwise returns \c false. \sa object() */ @@ -2297,25 +2297,25 @@ QString QAccessibleTextInterface::textAtOffset(int offset, QAccessible::TextBoun /*! \fn virtual bool QAccessibleTableInterface::selectRow(int row) Selects \a row. This function might unselect all previously selected rows. - Returns true if the selection was successful. + Returns \c true if the selection was successful. */ /*! \fn virtual bool QAccessibleTableInterface::selectColumn(int column) Selects \a column. This function might unselect all previously selected columns. - Returns true if the selection was successful. + Returns \c true if the selection was successful. */ /*! \fn virtual bool QAccessibleTableInterface::unselectRow(int row) Unselects \a row, leaving other selected rows selected (if any). - Returns true if the selection was successful. + Returns \c true if the selection was successful. */ /*! \fn virtual bool QAccessibleTableInterface::unselectColumn(int column) Unselects \a column, leaving other selected columns selected (if any). - Returns true if the selection was successful. + Returns \c true if the selection was successful. */ /*! -- cgit v1.2.3