feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: edit coreplugin docs

Browse Source 
Remove \brief commands for functions.
Use standard wording for QDoc commands.
Fix style and grammar issues.
Use the \a command instead of the \c command for attributes
in function descriptions.
Do not use \returns, because it does not exist.

Change-Id: Icd32b519670cb376e246bab3a58fe7e98d2529ea
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
Leena Miettinen
2013-09-06 16:38:53 +02:00
committed by Eike Ziller
parent 65f0588196
commit 120bf88eab
14 changed files with 281 additions and 243 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/plugins/coreplugin/featureprovider.cpp
View File

@@ -39,8 +39,10 @@
The features provided by an object in the object pool implementing IFeatureProvider
will be respected by wizards implementing IWizard.
This feature set, provided by all instances of IFeatureProvider in the object pool, is checked against IWizard::requiredFeatures()
and only if all required features are available the wizard is displayed when creating a new file or project.
This feature set, provided by all instances of IFeatureProvider in the
object pool, is checked against \c IWizard::requiredFeatures()
and only if all required features are available, the wizard is displayed
when creating a new file or project.
Qt4VersionManager creates an instance of IFeatureProvider and provides Qt specific features for the available
versions of Qt.
@@ -95,11 +97,11 @@
/*!
\fn bool Features::~contains(const Feature &feature)()
\returns true if the \param features is available.
Returns true if \a feature is available.
*/
/*!
\fn bool Features::~contains(const Features &features)()
\returns true if all \param features are available.
Returns true if all \a features are available.
*/