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

Doc: fix function signatures in code documentation

Browse Source 
QDoc cannot find functions if the signature in the \fn command
is not identical to the declaration, including 'const' qualifiers.

Removed the \fn where the documentation comes immediately before the
function, as qdoc does not need it in that case.

Change-Id: If6a2a2e2d58b394905c803787d2a93489049e4ca
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
Leena Miettinen
2013-05-23 16:13:55 +02:00
parent c88d7be702
commit 26c412deac
23 changed files with 75 additions and 211 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -60,7 +60,7 @@
*/
/*!
\fn FeatureProvider::Features availableFeatures() const;
\fn FetureSet IFeatureProvider::availableFeatures(const QString &platform) const
Returns available features provided by this manager.
\sa FeatureProvider::Features
*/
@@ -96,13 +96,13 @@
/*!
\fn bool Features::~contains(const Feature &feature)()
\fn bool FeatureSet::contains(const Feature &feature) const
\returns true if the \param features is available.
*/
/*!
\fn bool Features::~contains(const Features &features)()
\fn bool FeatureSet::contains(const FeatureSet &features) const
\returns true if all \param features are available.
*/