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

4
src/libs/utils/filesystemwatcher.cpp
View File

@@ -163,7 +163,7 @@ bool FileSystemWatcherPrivate::checkLimit() const
}
/*!
\brief Add to watcher 0.
Adds directories to watcher 0.
*/
FileSystemWatcher::FileSystemWatcher(QObject *parent) :
@@ -173,7 +173,7 @@ FileSystemWatcher::FileSystemWatcher(QObject *parent) :
}
/*!
\brief Add to a watcher with specified id.
Adds directories to a watcher with the specified \a id.
*/
FileSystemWatcher::FileSystemWatcher(int id, QObject *parent) :