Doc: move Class View plugin docs to .cpp files.

QDoc does not find docs in the .h files.
Use \brief only for namespaces, classes, enums, and properties.
Use standard wording for \brief and \fn.
Use \a and \c according to guidelines.

Fix grammar and style.

Change-Id: Ib685a03c97ef38661ecc156f61d70085514357fc
Reviewed-by: Erik Verbruggen <erik.verbruggen@digia.com>

1 files changed, 0 insertions, 84 deletions

diff --git a/src/plugins/classview/classviewparsertreeitem.h b/src/plugins/classview/classviewparsertreeitem.h
index bda9c8609f..cbdb9a277b 100644
--- a/src/plugins/classview/classviewparsertreeitem.h
+++ b/src/plugins/classview/classviewparsertreeitem.h
@@ -42,14 +42,6 @@ namespace Internal {
 
 class ParserTreeItemPrivate;
 
-/*!
-   \class ParserTreeItem
-   \brief Item for the internal Class View Tree
-
-   Item for Class View Tree.
-   Not virtual - to speed up its work.
- */
-
 class ParserTreeItem
 {
 public:
@@ -60,85 +52,28 @@ public:
     ParserTreeItem();
     ~ParserTreeItem();
 
-    /*!
-       \brief Copy content of \a from item with children to this one.
-       \param from 'From' item
-     */
     void copyTree(const ParserTreeItem::ConstPtr &from);
 
-    /*!
-       \brief Copy of \a from item to this one.
-       \param from 'From' item
-     */
     void copy(const ParserTreeItem::ConstPtr &from);
 
-    /*!
-       \brief Add information about symbol location
-       \param location Filled \a SymbolLocation struct with a correct information
-       \sa SymbolLocation, removeSymbolLocation, symbolLocations
-     */
     void addSymbolLocation(const SymbolLocation &location);
 
-    /*!
-       \brief Add information about symbol locations
-       \param locations Filled \a SymbolLocation struct with a correct information
-       \sa SymbolLocation, removeSymbolLocation, symbolLocations
-     */
     void addSymbolLocation(const QSet<SymbolLocation> &locations);
 
-    /*!
-       \brief Remove information about symbol location
-       \param location Filled \a SymbolLocation struct with a correct information
-       \sa SymbolLocation, addSymbolLocation, symbolLocations
-     */
     void removeSymbolLocation(const SymbolLocation &location);
 
-    /*!
-       \brief Remove information about symbol locations
-       \param locations Filled \a SymbolLocation struct with a correct information
-       \sa SymbolLocation, addSymbolLocation, symbolLocations
-     */
     void removeSymbolLocations(const QSet<SymbolLocation> &locations);
 
-    /*!
-       \brief Get information about symbol positions
-       \sa SymbolLocation, addSymbolLocation, removeSymbolLocation
-     */
     QSet<SymbolLocation> symbolLocations() const;
 
-    /*!
-       \brief Append child
-       \param item Child item
-       \param inf Symbol information
-     */
     void appendChild(const ParserTreeItem::Ptr &item, const SymbolInformation &inf);
 
-    /*!
-       \brief Remove child
-       \param inf SymbolInformation which has to be removed
-     */
     void removeChild(const SymbolInformation &inf);
 
-    /*!
-       \brief Get an item
-       \param inf Symbol information about needed child
-       \return Found child
-     */
     ParserTreeItem::Ptr child(const SymbolInformation &inf) const;
 
-    /*!
-       \brief How many children
-       \return Amount of chilren
-     */
     int childCount() const;
 
-    /*!
-       \brief Append this item to the \a QStandardIten item
-       \param item QStandardItem
-       \param recursive Do it recursively for the tree items or not (might be needed for
-                        the lazy data population
-
-     */
     void convertTo(QStandardItem *item, bool recursive = true) const;
 
     // additional properties
@@ -148,33 +83,14 @@ public:
     //! Set an icon for this tree node
     void setIcon(const QIcon &icon);
 
-    /*!
-       \brief Add an internal state with \a target.
-       \param target Item which contains the correct current state
-     */
     void add(const ParserTreeItem::ConstPtr &target);
 
-    /*!
-       \brief Subtract an internal state with \a target.
-       \param target Item which contains the subtrahend
-     */
     void subtract(const ParserTreeItem::ConstPtr &target);
 
-    /*!
-       \brief Lazy data population for a \a QStandardItemModel
-       \param item Item which has to be checked
-     */
     bool canFetchMore(QStandardItem *item) const;
 
-    /*!
-       \brief Lazy data population for a \a QStandardItemModel
-       \param item Item which will be populated (if needed)
-     */
     void fetchMore(QStandardItem *item) const;
 
-    /*!
-       \brief Debug dump
-     */
     void debugDump(int ident = 0) const;
 
 protected: