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/io/qfsfileengine.cpp | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'src/corelib/io/qfsfileengine.cpp') diff --git a/src/corelib/io/qfsfileengine.cpp b/src/corelib/io/qfsfileengine.cpp index f0f3c935e6..998a3334c9 100644 --- a/src/corelib/io/qfsfileengine.cpp +++ b/src/corelib/io/qfsfileengine.cpp @@ -224,8 +224,8 @@ bool QFSFileEngine::open(QIODevice::OpenMode openMode) } /*! - Opens the file handle \a fh in \a openMode mode. Returns true on - success; otherwise returns false. + Opens the file handle \a fh in \a openMode mode. Returns \c true on + success; otherwise returns \c false. */ bool QFSFileEngine::open(QIODevice::OpenMode openMode, FILE *fh) { @@ -285,8 +285,8 @@ bool QFSFileEnginePrivate::openFh(QIODevice::OpenMode openMode, FILE *fh) } /*! - Opens the file descriptor \a fd in \a openMode mode. Returns true - on success; otherwise returns false. + Opens the file descriptor \a fd in \a openMode mode. Returns \c true + on success; otherwise returns \c false. */ bool QFSFileEngine::open(QIODevice::OpenMode openMode, int fd) { @@ -837,7 +837,7 @@ bool QFSFileEngine::supportsExtension(Extension extension) const } /*! \fn bool QFSFileEngine::caseSensitive() const - Returns true for Windows, false for Unix. + Returns \c true for Windows, false for Unix. */ /*! \fn bool QFSFileEngine::copy(const QString ©Name) @@ -892,7 +892,7 @@ bool QFSFileEngine::supportsExtension(Extension extension) const Creates a link from the file currently specified by fileName() to \a newName. What a link is depends on the underlying filesystem (be it a shortcut on Windows or a symbolic link on Unix). Returns - true if successful; otherwise returns false. + true if successful; otherwise returns \c false. */ /*! \fn bool QFSFileEngine::mkdir(const QString &name, bool createParentDirectories) const @@ -935,8 +935,8 @@ bool QFSFileEngine::supportsExtension(Extension extension) const */ /*! \fn bool QFSFileEngine::setCurrentPath(const QString &path) - Sets the current path (e.g., for QDir), to \a path. Returns true if the - new path exists; otherwise this function does nothing, and returns false. + Sets the current path (e.g., for QDir), to \a path. Returns \c true if the + new path exists; otherwise this function does nothing, and returns \c false. \sa currentPath() */ -- cgit v1.2.3