From 770b2f1bc6bbc01ea72c3920accc262bd8ec81ce Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@qt.io>
Date: Tue, 4 Feb 2020 16:59:55 +0100
Subject: Doc: Fix PreprosessorClient docs

Fix values of \fn commands and document attributes.

Change-Id: Id09eb30e861289e9d982d7e0f914c68114ecf50c
Reviewed-by: hjk <hjk@qt.io>
---
 src/libs/cplusplus/PreprocessorClient.cpp | 36 ++++++++++++++++++++-----------
 1 file changed, 23 insertions(+), 13 deletions(-)

diff --git a/src/libs/cplusplus/PreprocessorClient.cpp b/src/libs/cplusplus/PreprocessorClient.cpp
index 68be342821..9705cf4097 100644
--- a/src/libs/cplusplus/PreprocessorClient.cpp
+++ b/src/libs/cplusplus/PreprocessorClient.cpp
@@ -36,34 +36,44 @@ using namespace CPlusPlus;
 /*!
     \fn void Client::macroAdded(const Macro &macro)
 
-    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 &macro)
+    \fn void Client::passedMacroDefinitionCheck(int bytesOffset,
+                                                int utf16charsOffset,
+                                                int line,
+                                                const Macro &macro)
 
-    Called when the preprocessor checks whether a macro is defined or not and the
-    result is positive.
+    Called when the preprocessor checks whether \a macro at \a line with
+    \a bytesOffset and \a utf16charsOffset is defined and the result is
+    positive.
 
     \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
-    result is negative.
+    Called when the preprocessor checks whether the macro specified by \a name
+    is defined with \a bytesOffset and \a utf16charsOffset and the result is
+    negative.
 
     \sa passedMacroDefinitionCheck()
 */
 
 /*!
-    \fn void Client::startExpandingMacro(int offset,
-                                   int line,
-                                   const Macro &macro,
-                                   const QVector<MacroArgumentReference> &actuals
-                                            = QVector<MacroArgumentReference>())
-    Called when starting to expand a macro.
+    \fn void Client::startExpandingMacro(int bytesOffset,
+                                         int utf16charsOffset,
+                                         int line,
+                                         const Macro &macro,
+                                         const QVector<MacroArgumentReference> &actuals
+                                               = QVector<MacroArgumentReference>())
+
+    Called when starting to expand \a macro at \a line with \a bytesOffset,
+    \a utf16charsOffset, and \a actuals.
 
     \sa stopExpandingMacro()
 */
-- 
cgit v1.2.1