Doc: use standard wording in \brief commands

QDoc does some magic with the \class and \namespaces
and \brief commands, so the following wording must be used:
"The xxx class yyy ..."

Change-Id: Id231f30e8464898b776888d5423523de404aae34
Reviewed-by: Eike Ziller <eike.ziller@digia.com>

3 files changed, 48 insertions, 24 deletions

diff --git a/src/libs/qtcreatorcdbext/symbolgroup.cpp b/src/libs/qtcreatorcdbext/symbolgroup.cpp
index 0a4361147f..5fc8113fdc 100644
--- a/src/libs/qtcreatorcdbext/symbolgroup.cpp
+++ b/src/libs/qtcreatorcdbext/symbolgroup.cpp
@@ -46,7 +46,9 @@ enum { debug = 0 };
 // ------------- SymbolGroup
 
 /*!
-  \class SymbolGroup A symbol group storing a tree of expanded symbols rooted on a fake "locals" root element.
+  \class SymbolGroup
+  \brief The SymbolGroup class creates a symbol group storing a tree of
+  expanded symbols rooted on a fake "locals" root element.
 
   Provides a find() method based on inames ("locals.this.i1.data") and
   dump() methods used for GDBMI-format dumping and debug helpers.
@@ -533,8 +535,10 @@ AbstractSymbolGroupNode *SymbolGroup::find(const std::string &iname) const
 
 /*!
     \class LocalsSymbolGroup
+    \brief The LocalsSymbolGroup class creates a Symbol group representing the
+    Locals view.
 
-    Symbol group representing the Locals view. It is firmly associated
+    It is firmly associated
     with stack frame, function (module) and thread.
     \ingroup qtcreatorcdbext
 */
@@ -624,7 +628,9 @@ std::string LocalsSymbolGroup::module() const
 /*!
   \class WatchesSymbolGroup
 
-  Watch symbol group. Contains watches as added by Qt Creator as iname='watch.0',
+  \brief The WatchesSymbolGroup class creates a watch symbol group.
+
+  Contains watches as added by \QC as iname='watch.0',
   name='<expression>'. The IDebugSymbolGroup is created without scope.
   \ingroup qtcreatorcdbext
 */
diff --git a/src/libs/qtcreatorcdbext/symbolgroupnode.cpp b/src/libs/qtcreatorcdbext/symbolgroupnode.cpp
index 8e671e6451..12e79b7372 100644
--- a/src/libs/qtcreatorcdbext/symbolgroupnode.cpp
+++ b/src/libs/qtcreatorcdbext/symbolgroupnode.cpp
@@ -90,7 +90,8 @@ inline std::ostream &operator<<(std::ostream &str, const DebugNodeFlags &f)
 /*!
   \class AbstractSymbolGroupNode
 
-    Abstract base class for a node of SymbolGroup providing the child list interface.
+    \brief The AbstractSymbolGroupNode class is an abstract base class for a
+    node of SymbolGroup providing the child list interface.
     \ingroup qtcreatorcdbext
 */
 AbstractSymbolGroupNode::AbstractSymbolGroupNode(const std::string &name,
@@ -207,7 +208,8 @@ void AbstractSymbolGroupNode::setParent(AbstractSymbolGroupNode *n)
 
 /*! \class BaseSymbolGroupNode
 
-    Base class for a node of SymbolGroup with a flat list of children.
+    \brief The BaseSymbolGroupNode class is the base class for a node of
+    SymbolGroup with a flat list of children.
     \ingroup qtcreatorcdbext
 */
 
@@ -276,9 +278,11 @@ std::ostream &operator<<(std::ostream &str, const DEBUG_SYMBOL_PARAMETERS &param
     return str;
 }
 
-/*! \struct DumpParameters
+/*!
+    \class DumpParameters
 
-    All parameters for GDBMI dumping of a symbol group in one struct.
+    \brief The DumpParameters class contains all parameters for GDBMI dumping
+    of a symbol group in one class.
     The debugging engine passes maps of type names/inames to special
     integer values indicating hex/dec, etc.
     \ingroup qtcreatorcdbext
@@ -580,7 +584,8 @@ void ErrorSymbolGroupNode::debug(std::ostream &os, const std::string &visitingFu
 
 /*! \class SymbolGroupNode
 
- \brief 'Real' node within a symbol group, identified by its index in IDebugSymbolGroup.
+ \brief The SymbolGroupNode class represents a \e real node within a symbol
+ group, identified by its index in IDebugSymbolGroup.
 
  Provides accessors for fixed-up symbol group value and a dumping facility
  consisting of:
@@ -1472,8 +1477,11 @@ static inline StringStringPair arrayIndexNameIname(int index)
 
 /*! \class ReferenceSymbolGroupNode
 
-    Artificial node referencing another (real) SymbolGroupNode (added symbol or
-    symbol from within an expanded linked list structure). Forwards the
+    \brief The ReferenceSymbolGroupNode class is an artificial node referencing
+    another (real) SymbolGroupNode (added symbol or symbol from within an
+    expanded linked list structure).
+
+    Forwards the
     dumping to the referenced node using its own name.
     \ingroup qtcreatorcdbext */
 
@@ -1509,7 +1517,8 @@ void ReferenceSymbolGroupNode::debug(std::ostream &str, const std::string &visit
 
 /*! \class MapNodeSymbolGroupNode
 
-  \brief A [fake] map node with a fake array index and key/value entries consisting
+  \brief The MapNodeSymbolGroupNode class is a [fake] map node with a fake
+         array index and key/value entries consisting
          of ReferenceSymbolGroupNode.
   \ingroup qtcreatorcdbext
 */
@@ -1559,9 +1568,11 @@ void MapNodeSymbolGroupNode::debug(std::ostream &os, const std::string &visiting
 
 /*! \class SymbolGroupNodeVisitor
 
-    Visitor that takes care of iterating over the nodes and
-    building the full iname path ('local.foo.bar') that is required for
-    GDBMI dumping. The full name depends on the path on which a node was reached
+    \brief The SymbolGroupNodeVisitor class is a visitor that iterates over the
+    nodes and builds the full iname path ('local.foo.bar') that is required for
+    GDBMI dumping.
+
+    The full name depends on the path on which a node was reached
     for referenced nodes (a linked list element can be reached via array index
     or by expanding the whole structure).
     visit() is not called for the (invisible) root node, but starting with the
@@ -1578,7 +1589,7 @@ std::string SymbolGroupNodeVisitor::parentIname(const std::string &iname)
 }
 
 /*! \class DebugSymbolGroupNodeVisitor
-    \brief Debug output visitor.
+    \brief The DebugSymbolGroupNodeVisitor class is a debug output visitor.
     \ingroup qtcreatorcdbext
 */
 
@@ -1597,7 +1608,8 @@ SymbolGroupNodeVisitor::VisitResult
 }
 
 /*! \class DebugFilterSymbolGroupNodeVisitor
-    \brief Debug filtering output visitor.
+    \brief The DebugFilterSymbolGroupNodeVisitor class is a debug filtering
+    output visitor.
     \ingroup qtcreatorcdbext
 */
 
@@ -1620,9 +1632,9 @@ SymbolGroupNodeVisitor::VisitResult
 }
 
 /*! \class DumpSymbolGroupNodeVisitor
-
-    GDBMI dump output visitor used to report locals values back to the
-    debugging engine.  \ingroup qtcreatorcdbext
+    \brief The DumpSymbolGroupNodeVisitor class is a GDBMI dump output visitor
+    used to report locals values back to the debugging engine.
+    \ingroup qtcreatorcdbext
 */
 
 DumpSymbolGroupNodeVisitor::DumpSymbolGroupNodeVisitor(std::ostream &os,
diff --git a/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp b/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp
index 66fc986e82..2a1200a953 100644
--- a/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp
+++ b/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp
@@ -47,15 +47,18 @@
 
 typedef std::vector<int>::size_type VectorIndexType;
 
-/*! \struct SymbolGroupValueContext
-    \brief Structure to pass all IDebug interfaces required for SymbolGroupValue
+/*!
+    \class SymbolGroupValueContext
+    \brief The SymbolGroupValueContext class passes all IDebug interfaces
+    required for SymbolGroupValue.
     \ingroup qtcreatorcdbext */
 
 /*! \class SymbolGroupValue
 
-    Flyweight tied to a SymbolGroupNode
+    \brief The SymbolGroupValue class is a flyweight tied to a SymbolGroupNode
     providing a convenient operator[] (name, index) and value
     getters for notation of dumpers.
+
     Inaccessible members return a SymbolGroupValue in state 'invalid'.
     Example:
     \code
@@ -681,9 +684,12 @@ static inline std::string resolveQtSymbol(const char *symbolC,
     return rc;
 }
 
-/*! \struct QtInfo
+/*!
+    \class QtInfo
+
+    \brief The QtInfo class provides Qt information determined on demand.
 
-    Qt Information determined on demand: Namespace, modules and basic class
+    Namespace, modules, and basic class
     names containing the module for fast lookup.
     \ingroup qtcreatorcdbext */