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/projectexplorer/runconfiguration.cpp
View File

@@ -298,7 +298,7 @@ Utils::OutputFormatter *RunConfiguration::createOutputFormatter() const
*/
/*!
\fn QString ProjectExplorer::IRunConfigurationFactory::displayNameForId(const QString &id) const
\fn QString ProjectExplorer::IRunConfigurationFactory::displayNameForId(const Core::Id id) const
\brief Used to translate the types to names to display to the user.
*/
@@ -375,7 +375,7 @@ QList<IRunConfigurationFactory *> IRunConfigurationFactory::find(Target *parent)
*/
/*!
\fn IRunConfigurationAspect *ProjectExplorer::IRunControlFactory::createRunConfigurationAspect()
\fn IRunConfigurationAspect *ProjectExplorer::IRunControlFactory::createRunConfigurationAspect(RunConfiguration *rc)
\brief Return an IRunConfigurationAspect to carry options for RunControls this factory can create.
If no extra options are required it is allowed to return null like the default implementation does.
@@ -384,7 +384,7 @@ QList<IRunConfigurationFactory *> IRunConfigurationFactory::find(Target *parent)
*/
/*!
\fn RunConfigWidget *ProjectExplorer::IRunControlFactory::createConfigurationWidget(RunConfiguration *runConfiguration)
\fn RunConfigWidget *ProjectExplorer::IRunConfigurationAspect::createConfigurationWidget()
\brief Return a widget used to configure this runner. Ownership is transferred to the caller.