diff options
author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-05-23 16:13:55 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-05-23 16:30:35 +0200 |
commit | 26c412deaca32aa7a8b7b122ea6369bc22af36e1 (patch) | |
tree | 6af341a3cdbfd6a1e9cdd7bfcb069f7d54c8d8ff /src/libs/cplusplus/PreprocessorClient.cpp | |
parent | c88d7be702f66f441d00fdf7e73ff578d511a5cf (diff) | |
download | qt-creator-26c412deaca32aa7a8b7b122ea6369bc22af36e1.tar.gz |
Doc: fix function signatures in code documentation
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>
Diffstat (limited to 'src/libs/cplusplus/PreprocessorClient.cpp')
-rw-r--r-- | src/libs/cplusplus/PreprocessorClient.cpp | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/src/libs/cplusplus/PreprocessorClient.cpp b/src/libs/cplusplus/PreprocessorClient.cpp index f40e6d92c5..7cd95e7810 100644 --- a/src/libs/cplusplus/PreprocessorClient.cpp +++ b/src/libs/cplusplus/PreprocessorClient.cpp @@ -43,7 +43,7 @@ using namespace CPlusPlus; */ /*! - \fn void Client::passedMacroDefinitionCheck(unsigned offset, const Macro ¯o) + \fn void Client::passedMacroDefinitionCheck(unsigned offset, unsigned line, const Macro ¯o) 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 ¯o, 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 ¯o, + const QVector<MacroArgumentReference> &actuals + = QVector<MacroArgumentReference>()) + Called when starting to expand a macro. \sa stopExpandingMacro() */ |