feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: edit utils docs

Browse Source 
Use \a for all attributes in function descriptions
to avoid QDoc errors. Do not use \param, because
it is not a valid QDoc command.

Do not use \returns as it does not exist.

Do not use \brief for functions. It is not obligatory, so
rather than add them for all functions, let's consistenly leave them out.

Fix typos, grammar and style issues, and punctuation.

Change-Id: Ib8f296f93976265bb93dbeab40c5b47156518122
Reviewed-by: hjk <hjk121@nokiamail.com>
This commit is contained in:
Leena Miettinen
2013-09-06 13:23:11 +02:00
parent 5358ffe903
commit efbecf21db
14 changed files with 86 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/libs/utils/fileutils.cpp
View File

@@ -52,7 +52,7 @@ namespace Utils {
\note The \a error parameter is optional.
\return Whether the operation succeeded.
Returns whether the operation succeeded.
*/
bool FileUtils::removeRecursively(const FileName &filePath, QString *error)
{
@@ -118,7 +118,7 @@ bool FileUtils::removeRecursively(const FileName &filePath, QString *error)
\note The \a error parameter is optional.
\return Whether the operation succeeded.
Returns whether the operation succeeded.
*/
bool FileUtils::copyRecursively(const FileName &srcFilePath, const FileName &tgtFilePath,
QString *error)
@@ -162,7 +162,8 @@ bool FileUtils::copyRecursively(const FileName &srcFilePath, const FileName &tgt
true if one of them is newer than \a timeStamp. If \a filePath is a single file, true will
be returned if the file is newer than \timeStamp.
\return Whether at least one file in \a filePath has a newer date than \a timeStamp.
Returns whether at least one file in \a filePath has a newer date than
\a timeStamp.
*/
bool FileUtils::isFileNewerThan(const FileName &filePath, const QDateTime &timeStamp)
{
@@ -181,13 +182,13 @@ bool FileUtils::isFileNewerThan(const FileName &filePath, const QDateTime &timeS
}
/*!
Recursively resolve possibly present symlinks in \a filePath.
Recursively resolves possibly present symlinks in \a filePath.
Unlike QFileInfo::canonicalFilePath(), this function will still return the expected target file
even if the symlink is dangling.
\note Maximum recursion depth == 16.
return Symlink target file path.
Returns the symlink target file path.
*/
FileName FileUtils::resolveSymlinks(const FileName &path)
{
@@ -204,7 +205,7 @@ FileName FileUtils::resolveSymlinks(const FileName &path)
Like QDir::toNativeSeparators(), but use prefix '~' instead of $HOME on unix systems when an
absolute path is given.
return Possibly shortened path with native separators.
Returns the possibly shortened path with native separators.
*/
QString FileUtils::shortNativePath(const FileName &path)
{