forked from qt-creator/qt-creator
Doc: Fix PreprosessorClient docs
Fix values of \fn commands and document attributes. Change-Id: Id09eb30e861289e9d982d7e0f914c68114ecf50c Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
@@ -36,34 +36,44 @@ using namespace CPlusPlus;
|
|||||||
/*!
|
/*!
|
||||||
\fn void Client::macroAdded(const Macro ¯o)
|
\fn void Client::macroAdded(const Macro ¯o)
|
||||||
|
|
||||||
Called whenever a new macro is defined.
|
Called whenever a new \a macro is defined.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\fn void Client::passedMacroDefinitionCheck(int offset, int line, const Macro ¯o)
|
\fn void Client::passedMacroDefinitionCheck(int bytesOffset,
|
||||||
|
int utf16charsOffset,
|
||||||
|
int line,
|
||||||
|
const Macro ¯o)
|
||||||
|
|
||||||
Called when the preprocessor checks whether a macro is defined or not and the
|
Called when the preprocessor checks whether \a macro at \a line with
|
||||||
result is positive.
|
\a bytesOffset and \a utf16charsOffset is defined and the result is
|
||||||
|
positive.
|
||||||
|
|
||||||
\sa failedMacroDefinitionCheck()
|
\sa failedMacroDefinitionCheck()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\fn void Client::failedMacroDefinitionCheck(int offset, const ByteArrayRef &name)
|
\fn void Client::failedMacroDefinitionCheck(int bytesOffset,
|
||||||
|
int utf16charsOffset,
|
||||||
|
const ByteArrayRef &name)
|
||||||
|
|
||||||
Called when the preprocessor checks whether a macro is defined or not and the
|
Called when the preprocessor checks whether the macro specified by \a name
|
||||||
result is negative.
|
is defined with \a bytesOffset and \a utf16charsOffset and the result is
|
||||||
|
negative.
|
||||||
|
|
||||||
\sa passedMacroDefinitionCheck()
|
\sa passedMacroDefinitionCheck()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\fn void Client::startExpandingMacro(int offset,
|
\fn void Client::startExpandingMacro(int bytesOffset,
|
||||||
|
int utf16charsOffset,
|
||||||
int line,
|
int line,
|
||||||
const Macro ¯o,
|
const Macro ¯o,
|
||||||
const QVector<MacroArgumentReference> &actuals
|
const QVector<MacroArgumentReference> &actuals
|
||||||
= QVector<MacroArgumentReference>())
|
= QVector<MacroArgumentReference>())
|
||||||
Called when starting to expand a macro.
|
|
||||||
|
Called when starting to expand \a macro at \a line with \a bytesOffset,
|
||||||
|
\a utf16charsOffset, and \a actuals.
|
||||||
|
|
||||||
\sa stopExpandingMacro()
|
\sa stopExpandingMacro()
|
||||||
*/
|
*/
|
||||||
|
Reference in New Issue
Block a user