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

Doc: use standard wording in \brief commands

Browse Source 
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>
This commit is contained in:
Leena Miettinen
2013-06-05 14:29:24 +02:00
parent 440725322a
commit 41411165ba
162 changed files with 486 additions and 291 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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
\brief The FeatureSet class is a set of available or required feature sets.
Features is used to describe available or
required feature sets and behaves similar to QFlags.
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