diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-06 13:23:11 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-09 12:55:00 +0200 |
| commit | efbecf21dbdbc803c4c016fdb90803edec82cf19 (patch) | |
| tree | 9a086a1ac450672774e04fde82efef95db23f71d /src/libs/utils/filesystemwatcher.cpp | |
| parent | 5358ffe9036c09a4ee5d0135159064ec9a226037 (diff) | |
| download | qt-creator-efbecf21dbdbc803c4c016fdb90803edec82cf19.tar.gz | |
Doc: edit utils docs
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>
Diffstat (limited to 'src/libs/utils/filesystemwatcher.cpp')
| -rw-r--r-- | src/libs/utils/filesystemwatcher.cpp | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/libs/utils/filesystemwatcher.cpp b/src/libs/utils/filesystemwatcher.cpp index 2811f8c249..8110ce91bc 100644 --- a/src/libs/utils/filesystemwatcher.cpp +++ b/src/libs/utils/filesystemwatcher.cpp @@ -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) : |