summaryrefslogtreecommitdiffstats
path: root/src/network/bearer
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/network/bearer
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/network/bearer')
-rw-r--r--src/network/bearer/qbearerengine.cpp4
-rw-r--r--src/network/bearer/qnetworkconfigmanager.cpp4
-rw-r--r--src/network/bearer/qnetworkconfiguration.cpp12
-rw-r--r--src/network/bearer/qnetworksession.cpp4
4 files changed, 12 insertions, 12 deletions
diff --git a/src/network/bearer/qbearerengine.cpp b/src/network/bearer/qbearerengine.cpp
index e07426025e..520323471a 100644
--- a/src/network/bearer/qbearerengine.cpp
+++ b/src/network/bearer/qbearerengine.cpp
@@ -82,9 +82,9 @@ bool QBearerEngine::requiresPolling() const
}
/*
- Returns true if configurations are in use; otherwise returns false.
+ Returns \c true if configurations are in use; otherwise returns \c false.
- If configurations are in use and requiresPolling() returns true, polling will be enabled for
+ If configurations are in use and requiresPolling() returns \c true, polling will be enabled for
this engine.
*/
bool QBearerEngine::configurationsInUse() const
diff --git a/src/network/bearer/qnetworkconfigmanager.cpp b/src/network/bearer/qnetworkconfigmanager.cpp
index 933bebe2ad..dc36443718 100644
--- a/src/network/bearer/qnetworkconfigmanager.cpp
+++ b/src/network/bearer/qnetworkconfigmanager.cpp
@@ -321,8 +321,8 @@ QNetworkConfiguration QNetworkConfigurationManager::configurationFromIdentifier(
}
/*!
- Returns true if the system is considered to be connected to another device via an active
- network interface; otherwise returns false.
+ Returns \c true if the system is considered to be connected to another device via an active
+ network interface; otherwise returns \c false.
This is equivalent to the following code snippet:
diff --git a/src/network/bearer/qnetworkconfiguration.cpp b/src/network/bearer/qnetworkconfiguration.cpp
index 40381a04c0..8d34db19cd 100644
--- a/src/network/bearer/qnetworkconfiguration.cpp
+++ b/src/network/bearer/qnetworkconfiguration.cpp
@@ -331,8 +331,8 @@ QNetworkConfiguration &QNetworkConfiguration::operator=(const QNetworkConfigurat
*/
/*!
- Returns true, if this configuration is the same as the \a other
- configuration given; otherwise returns false.
+ Returns \c true, if this configuration is the same as the \a other
+ configuration given; otherwise returns \c false.
*/
bool QNetworkConfiguration::operator==(const QNetworkConfiguration &other) const
{
@@ -342,8 +342,8 @@ bool QNetworkConfiguration::operator==(const QNetworkConfiguration &other) const
/*!
\fn bool QNetworkConfiguration::operator!=(const QNetworkConfiguration &other) const
- Returns true if this configuration is not the same as the \a other
- configuration given; otherwise returns false.
+ Returns \c true if this configuration is not the same as the \a other
+ configuration given; otherwise returns \c false.
*/
/*!
@@ -392,7 +392,7 @@ QNetworkConfiguration::Type QNetworkConfiguration::type() const
}
/*!
- Returns true if this QNetworkConfiguration object is valid.
+ Returns \c true if this QNetworkConfiguration object is valid.
A configuration may become invalid if the user deletes the configuration or
the configuration was default-constructed.
@@ -439,7 +439,7 @@ QNetworkConfiguration::Purpose QNetworkConfiguration::purpose() const
}
/*!
- Returns true if this configuration supports roaming; otherwise false.
+ Returns \c true if this configuration supports roaming; otherwise false.
*/
bool QNetworkConfiguration::isRoamingAvailable() const
{
diff --git a/src/network/bearer/qnetworksession.cpp b/src/network/bearer/qnetworksession.cpp
index cca95fce8c..98a8f27a6e 100644
--- a/src/network/bearer/qnetworksession.cpp
+++ b/src/network/bearer/qnetworksession.cpp
@@ -314,7 +314,7 @@ void QNetworkSession::open()
/*!
Waits until the session has been opened, up to \a msecs milliseconds. If the session has been opened, this
- function returns true; otherwise it returns false. In the case where it returns false, you can call error()
+ function returns \c true; otherwise it returns \c false. In the case where it returns \c false, you can call error()
to determine the cause of the error.
The following example waits up to one second for the session to be opened:
@@ -415,7 +415,7 @@ QNetworkInterface QNetworkSession::interface() const
#endif
/*!
- Returns true if this session is open. If the number of all open sessions is greater than
+ Returns \c true if this session is open. If the number of all open sessions is greater than
zero the underlying network interface will remain connected/up.
The session can be controlled via open() and close().