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/completingtextedit.cpp | |
parent | 5358ffe9036c09a4ee5d0135159064ec9a226037 (diff) |
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/completingtextedit.cpp')
-rw-r--r-- | src/libs/utils/completingtextedit.cpp | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/libs/utils/completingtextedit.cpp b/src/libs/utils/completingtextedit.cpp index 77f061c7b41..1e44ef90f0d 100644 --- a/src/libs/utils/completingtextedit.cpp +++ b/src/libs/utils/completingtextedit.cpp @@ -44,7 +44,7 @@ static bool isEndOfWordChar(const QChar &c) \brief The CompletingTextEdit class is a QTextEdit with auto-completion support. - Excerpted from Qt examples/tools/customcompleter + Excerpted from Qt examples/tools/customcompleter. */ namespace Utils { |