diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-06 16:38:53 +0200 |
|---|---|---|
| committer | Eike Ziller <eike.ziller@digia.com> | 2013-09-26 10:29:13 +0200 |
| commit | 120bf88eab1329f113e26e3cbaefa8dfa6652bbb (patch) | |
| tree | 413abfd1a3f32dc63e5b2da43d21e407f4e8ba52 /src/plugins/coreplugin/featureprovider.cpp | |
| parent | 65f05881963b2d54d9975d8ed27001813e1452f0 (diff) | |
| download | qt-creator-120bf88eab1329f113e26e3cbaefa8dfa6652bbb.tar.gz | |
Doc: edit coreplugin docs
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>
Diffstat (limited to 'src/plugins/coreplugin/featureprovider.cpp')
| -rw-r--r-- | src/plugins/coreplugin/featureprovider.cpp | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/src/plugins/coreplugin/featureprovider.cpp b/src/plugins/coreplugin/featureprovider.cpp index d2dd7ffb39..0aa2cff9a9 100644 --- a/src/plugins/coreplugin/featureprovider.cpp +++ b/src/plugins/coreplugin/featureprovider.cpp @@ -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. */ |