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>
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

View File

@@ -50,7 +50,7 @@
consisting of a QLineEdit and
a "Browse" button.
Has some validation logic for embedding into QWizardPage.
This class has some validation logic for embedding into QWizardPage.
*/
const char * const Utils::PathChooser::browseButtonLabel =