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

14
src/libs/cplusplus/PreprocessorClient.cpp
View File

@@ -43,7 +43,7 @@ using namespace CPlusPlus;
*/
/*!
\fn void Client::passedMacroDefinitionCheck(unsigned offset, const Macro &macro)
\fn void Client::passedMacroDefinitionCheck(unsigned offset, unsigned line, const Macro &macro)
Called when the preprocessor checks whether a macro is defined or not and the
result is positive.
@@ -52,7 +52,7 @@ using namespace CPlusPlus;
*/
/*!
\fn void Client::failedMacroDefinitionCheck(unsigned offset, const QByteArray &name)
\fn void Client::failedMacroDefinitionCheck(unsigned offset, const ByteArrayRef &name)
Called when the preprocessor checks whether a macro is defined or not and the
result is negative.
@@ -61,10 +61,12 @@ using namespace CPlusPlus;
*/
/*!
\fn void Client::startExpandingMacro(unsigned offset, const Macro &macro, const QByteArray &originalText, bool inCondition = false, const QVector<MacroArgumentReference> &actuals = QVector<MacroArgumentReference>())
Called when starting to expand a macro. The parameter \a inCondition indicates whether the
expansion is happening inside a preprocessor conditional.
\fn void Client::startExpandingMacro(unsigned offset,
unsigned line,
const Macro &macro,
const QVector<MacroArgumentReference> &actuals
= QVector<MacroArgumentReference>())
Called when starting to expand a macro.
\sa stopExpandingMacro()
*/