diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-05 14:29:24 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-20 11:22:47 +0200 |
| commit | 41411165bac561d3cd93a793c6ae76dcb2937e12 (patch) | |
| tree | cc9e5e516899407448ad8eadd207909ee3115493 /src/plugins/coreplugin/featureprovider.cpp | |
| parent | 440725322abf0189c0cb28baddebe76bc26c5f05 (diff) | |
| download | qt-creator-41411165bac561d3cd93a793c6ae76dcb2937e12.tar.gz | |
Doc: use standard wording in \brief commands
QDoc does some magic with the \class and \namespaces
and \brief commands, so the following wording must be used:
"The xxx class yyy ..."
Change-Id: Id231f30e8464898b776888d5423523de404aae34
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
Diffstat (limited to 'src/plugins/coreplugin/featureprovider.cpp')
| -rw-r--r-- | src/plugins/coreplugin/featureprovider.cpp | 17 |
1 files changed, 7 insertions, 10 deletions
diff --git a/src/plugins/coreplugin/featureprovider.cpp b/src/plugins/coreplugin/featureprovider.cpp index f0b1bde4f5..d2dd7ffb39 100644 --- a/src/plugins/coreplugin/featureprovider.cpp +++ b/src/plugins/coreplugin/featureprovider.cpp @@ -33,7 +33,8 @@ \class Core::IFeatureProvider \mainclass - \brief The class IFeatureProvider defines an interface to manage features for wizards + \brief The IFeatureProvider class defines an interface to manage features + for wizards. The features provided by an object in the object pool implementing IFeatureProvider will be respected by wizards implementing IWizard. @@ -68,10 +69,8 @@ /*! \class Core::Feature - \brief This class describes a single Feature - - This class describes a single Feature to be used - in Core::FeatureProvider::Features. + \brief The Feature class describes a single feature to be used in + Core::FeatureProvider::Features. \sa Core::FeaturesSet \sa Core::IWizard @@ -81,12 +80,10 @@ /*! \class Core::FeatureSet - \brief This class is a set of features - - Features is used to describe available or - required feature sets and behaves similar to QFlags. + \brief The FeatureSet class is a set of available or required feature sets. - But instead of enums Features relies on string ids + This class behaves similarly to QFlags. However, instead of enums, Features + relies on string ids and is therefore extendable. \sa Core::Feature |