summaryrefslogtreecommitdiffstats
path: root/src/dbus/qdbusutil.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/dbus/qdbusutil.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/dbus/qdbusutil.cpp')
-rw-r--r--src/dbus/qdbusutil.cpp24
1 files changed, 12 insertions, 12 deletions
diff --git a/src/dbus/qdbusutil.cpp b/src/dbus/qdbusutil.cpp
index c90490df7f..c77908ef89 100644
--- a/src/dbus/qdbusutil.cpp
+++ b/src/dbus/qdbusutil.cpp
@@ -350,7 +350,7 @@ namespace QDBusUtil
/*!
\fn bool QDBusUtil::isValidInterfaceName(const QString &ifaceName)
- Returns true if this is \a ifaceName is a valid interface name.
+ Returns \c true if this is \a ifaceName is a valid interface name.
Valid interface names must:
\list
@@ -379,7 +379,7 @@ namespace QDBusUtil
/*!
\fn bool QDBusUtil::isValidUniqueConnectionName(const QString &connName)
- Returns true if \a connName is a valid unique connection name.
+ Returns \c true if \a connName is a valid unique connection name.
Unique connection names start with a colon (":") and are followed by a list of dot-separated
components composed of ASCII letters, digits, the hyphen or the underscore ("_") character.
@@ -410,7 +410,7 @@ namespace QDBusUtil
/*!
\fn bool QDBusUtil::isValidBusName(const QString &busName)
- Returns true if \a busName is a valid bus name.
+ Returns \c true if \a busName is a valid bus name.
A valid bus name is either a valid unique connection name or follows the rules:
\list
@@ -453,7 +453,7 @@ namespace QDBusUtil
/*!
\fn bool QDBusUtil::isValidMemberName(const QString &memberName)
- Returns true if \a memberName is a valid member name. A valid member name does not exceed
+ Returns \c true if \a memberName is a valid member name. A valid member name does not exceed
255 characters in length, is not empty, is composed only of ASCII letters, digits and
underscores, but does not start with a digit.
*/
@@ -473,7 +473,7 @@ namespace QDBusUtil
/*!
\fn bool QDBusUtil::isValidErrorName(const QString &errorName)
- Returns true if \a errorName is a valid error name. Valid error names are valid interface
+ Returns \c true if \a errorName is a valid error name. Valid error names are valid interface
names and vice-versa, so this function is actually an alias for isValidInterfaceName.
*/
bool isValidErrorName(const QString &errorName)
@@ -483,7 +483,7 @@ namespace QDBusUtil
/*!
\fn bool QDBusUtil::isValidObjectPath(const QString &path)
- Returns true if \a path is valid object path.
+ Returns \c true if \a path is valid object path.
Valid object paths follow the rules:
\list
@@ -516,7 +516,7 @@ namespace QDBusUtil
/*!
\fn bool QDBusUtil::isValidBasicType(int type)
- Returns true if \a c is a valid, basic D-Bus type.
+ Returns \c true if \a c is a valid, basic D-Bus type.
*/
bool isValidBasicType(int c)
{
@@ -525,7 +525,7 @@ namespace QDBusUtil
/*!
\fn bool QDBusUtil::isValidFixedType(int type)
- Returns true if \a c is a valid, fixed D-Bus type.
+ Returns \c true if \a c is a valid, fixed D-Bus type.
*/
bool isValidFixedType(int c)
{
@@ -535,8 +535,8 @@ namespace QDBusUtil
/*!
\fn bool QDBusUtil::isValidSignature(const QString &signature)
- Returns true if \a signature is a valid D-Bus type signature for one or more types.
- This function returns true if it can all of \a signature into valid, individual types and no
+ Returns \c true if \a signature is a valid D-Bus type signature for one or more types.
+ This function returns \c true if it can all of \a signature into valid, individual types and no
characters remain in \a signature.
\sa isValidSingleSignature()
@@ -556,9 +556,9 @@ namespace QDBusUtil
/*!
\fn bool QDBusUtil::isValidSingleSignature(const QString &signature)
- Returns true if \a signature is a valid D-Bus type signature for exactly one full type. This
+ Returns \c true if \a signature is a valid D-Bus type signature for exactly one full type. This
function tries to convert the type signature into a D-Bus type and, if it succeeds and no
- characters remain in the signature, it returns true.
+ characters remain in the signature, it returns \c true.
*/
bool isValidSingleSignature(const QString &signature)
{