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

8
src/libs/utils/projectintropage.cpp
View File

@@ -42,13 +42,13 @@
Looks similar to FileWizardPage, but provides additional
functionality:
\list
\li Description label at the top for displaying introductory text
\li It does on the fly validation (connected to changed()) and displays
warnings/errors in a status label at the bottom (the page is complete
\li Contains a description label at the top for displaying introductory text.
\li Does on the fly validation (connected to changed()) and displays
warnings and errors in a status label at the bottom (the page is complete
when fully validated, validatePage() is thus not implemented).
\endlist
Note: Careful when changing projectintropage.ui. It must have main
\note Careful when changing projectintropage.ui. It must have main
geometry cleared and QLayout::SetMinimumSize constraint on the main
layout, otherwise, QWizard will squeeze it due to its strange expanding
hacks.