diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:51:05 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-08 00:46:27 +0200 |
commit | 4533cc994484a2308297e64e99af005fb4dca065 (patch) | |
tree | bc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/dbus/qdbusunixfiledescriptor.cpp | |
parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/qdbusunixfiledescriptor.cpp')
-rw-r--r-- | src/dbus/qdbusunixfiledescriptor.cpp | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/dbus/qdbusunixfiledescriptor.cpp b/src/dbus/qdbusunixfiledescriptor.cpp index db893337ae..63c5b40d06 100644 --- a/src/dbus/qdbusunixfiledescriptor.cpp +++ b/src/dbus/qdbusunixfiledescriptor.cpp @@ -197,7 +197,7 @@ QDBusUnixFileDescriptor::~QDBusUnixFileDescriptor() */ /*! - Returns true if this Unix file descriptor is valid. A valid Unix file + Returns \c true if this Unix file descriptor is valid. A valid Unix file descriptor is not -1. \sa fileDescriptor() @@ -231,11 +231,11 @@ int QDBusUnixFileDescriptor::fileDescriptor() const // qdoc documentation is generated on Unix /*! - Returns true if Unix file descriptors are supported on this platform. In - other words, this function returns true if this is a Unix platform. + Returns \c true if Unix file descriptors are supported on this platform. In + other words, this function returns \c true if this is a Unix platform. Note that QDBusUnixFileDescriptor continues to operate even if this - function returns false. The only difference is that the + function returns \c false. The only difference is that the QDBusUnixFileDescriptor objects will always be in the isValid() == false state and fileDescriptor() will always return -1. The class will not consume any operating system resources. |