Doc: move docs from h files to cpp files

QDoc does not look for docs in header files.

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

6 files changed, 102 insertions, 78 deletions

diff --git a/src/libs/cplusplus/Overview.cpp b/src/libs/cplusplus/Overview.cpp
index 615b6115b2..c5865ab541 100644
--- a/src/libs/cplusplus/Overview.cpp
+++ b/src/libs/cplusplus/Overview.cpp
@@ -38,6 +38,49 @@
 
 using namespace CPlusPlus;
 
+/*!
+    \class Overview
+
+    \brief The Overview class converts a FullySpecifiedType and/or any qualified
+    name to its string representation.
+
+    The public data members (except the ones starting with \e marked)
+    determine what exactly and how to print.
+
+    You can get the start and end position of a function argument
+    in the resulting string. Set \c markedArgument to the desired
+    argument. After processing, \c markedArgumentBegin and
+    \c markedArgumentEnd will contain the positions.
+*/
+
+/*!
+    \enum Overview::StarBindFlag
+
+    The StarBindFlag enum describes how the '*' and '&' in pointers/references
+    should be bound in the string representation.
+
+    This also applies to rvalue references ('&&'), but not to pointers to
+    functions or arrays, because it seems to be quite uncommon to use spaces in
+    them. For example:
+    \code
+      void (*p)()
+      void (*p)[]
+    \endcode
+
+    See the examples below. These assume that exactly one
+    flag is set. That is, it may look different with
+    flag combinations.
+
+      \value BindToIdentifier
+             e.g. "char *foo", but not "char * foo"
+      \value BindToTypeName
+             e.g. "char*", but not "char *"
+      \value BindToLeftSpecifier
+             e.g. "char * const* const", but not "char * const * const"
+      \value BindToRightSpecifier
+             e.g. "char *const", but not "char * const"
+*/
+
 Overview::Overview()
     : starBindFlags(BindToIdentifier), // default to "Qt Style"
       showArgumentNames(false),
diff --git a/src/libs/cplusplus/Overview.h b/src/libs/cplusplus/Overview.h
index 77453a04b5..020e70ede9 100644
--- a/src/libs/cplusplus/Overview.h
+++ b/src/libs/cplusplus/Overview.h
@@ -37,16 +37,6 @@
 
 namespace CPlusPlus {
 
-/*!
-   \class Overview
-
-   \brief Converts a FullySpecifiedType and/or any qualified name,
-          to its string representation.
-
-   The public data members (except the ones starting with "marked")
-   determine what exactly and how to print.
- */
-
 class CPLUSPLUS_EXPORT Overview
 {
 public:
@@ -67,33 +57,7 @@ public:
     QString prettyType(const FullySpecifiedType &type, const QString &name) const;
 
 public:
-    /*!
-        \enum Overview::StarBindFlag
-
-        The StarBindFlags describe how the '*' and '&' in pointers/references
-        should be bound in the string representation.
-
-        This also applies to rvalue references ('&&'), but not to
-        pointers to functions or arrays like in
-
-          void (*p)()
-          void (*p)[]
-
-        since it seems to be quite uncommon to use spaces there.
-
-        See the examples below. These assume that exactly one
-        flag is set. That is, it may look different with
-        flag combinations.
 
-          \value BindToIdentifier
-                 e.g. "char *foo", but not "char * foo"
-          \value BindToTypeName
-                 e.g. "char*", but not "char *"
-          \value BindToLeftSpecifier
-                 e.g. "char * const* const", but not "char * const * const"
-          \value BindToRightSpecifier
-                 e.g. "char *const", but not "char * const"
-     */
     enum StarBindFlag {
         BindToIdentifier = 0x1,
         BindToTypeName = 0x2,
@@ -110,12 +74,6 @@ public:
     bool showTemplateParameters: 1;
     bool includeWhiteSpaceInOperatorName: 1; /// "operator =()" vs "operator=()"
 
-    /*!
-        You can get the start and end position of a function argument
-        in the resulting string. Set "markedArgument" to the desired
-        argument. After processing, "markedArgumentBegin" and
-        "markedArgumentEnd" will contain the positions.
-     */
     unsigned markedArgument;
     int markedArgumentBegin;
     int markedArgumentEnd;
diff --git a/src/libs/cplusplus/TypePrettyPrinter.cpp b/src/libs/cplusplus/TypePrettyPrinter.cpp
index 2d70b9d789..6ec363ba92 100644
--- a/src/libs/cplusplus/TypePrettyPrinter.cpp
+++ b/src/libs/cplusplus/TypePrettyPrinter.cpp
@@ -42,6 +42,14 @@
 
 using namespace CPlusPlus;
 
+/*!
+   \class TypePrettyPrinter
+
+   \brief The TypePrettyPrinter class is a helper class for the Overview class.
+    This class does the main type conversion work.
+
+    Do not use this class directly, use Overview instead.
+ */
 
 TypePrettyPrinter::TypePrettyPrinter(const Overview *overview)
     : _overview(overview)
diff --git a/src/libs/cplusplus/TypePrettyPrinter.h b/src/libs/cplusplus/TypePrettyPrinter.h
index 09b87aa6a7..abd310b071 100644
--- a/src/libs/cplusplus/TypePrettyPrinter.h
+++ b/src/libs/cplusplus/TypePrettyPrinter.h
@@ -40,14 +40,6 @@ namespace CPlusPlus {
 class Overview;
 class FullySpecifiedType;
 
-/*!
-   \class TypePrettyPrinter
-
-   \brief Helper class for Overview. Does the main type conversation work.
-
-   Don't use this class directly, use Overview instead.
- */
-
 class CPLUSPLUS_EXPORT TypePrettyPrinter: protected TypeVisitor
 {
 public:
diff --git a/src/plugins/projectexplorer/devicesupport/idevicefactory.cpp b/src/plugins/projectexplorer/devicesupport/idevicefactory.cpp
index 6b841b3785..d75ec1cde3 100644
--- a/src/plugins/projectexplorer/devicesupport/idevicefactory.cpp
+++ b/src/plugins/projectexplorer/devicesupport/idevicefactory.cpp
@@ -33,6 +33,55 @@
 
 namespace ProjectExplorer {
 
+/*!
+    \class ProjectExplorer::IDeviceFactory
+
+    \brief The IDeviceFactory class implements an interface for classes that
+    provide services related to a certain type of device.
+
+    The factory objects have to be added to the global object pool via
+    \c ExtensionSystem::PluginManager::addObject().
+
+    \sa ExtensionSystem::PluginManager::addObject()
+*/
+
+/*!
+    \fn virtual QString displayNameForId(Core::Id type) const = 0
+
+    Returns a short, one-line description of the device type.
+*/
+
+/*!
+    \fn virtual QList<Core::Id> availableCreationIds() const = 0
+
+    Lists the device types this factory can create.
+*/
+
+/*!
+    \fn virtual IDevice::Ptr create(Core::Id id) const = 0
+    Creates a new device with the id \a id. This may or may not open a wizard.
+*/
+
+/*!
+    \fn virtual bool canRestore(const QVariantMap &map) const = 0
+
+    Checks whether this factory can restore a device from the serialized state
+    specified by \a map.
+*/
+
+/*!
+    \fn virtual IDevice::Ptr restore(const QVariantMap &map) const = 0
+
+    Loads a device from a serialized state. Only called if \c canRestore()
+    returns true for \a map.
+*/
+
+/*!
+    Checks whether this factory can create new devices. This function is used
+    to hide auto-detect-only factories from the listing of possible devices
+    to create.
+*/
+
 bool IDeviceFactory::canCreate() const
 {
     return !availableCreationIds().isEmpty();
diff --git a/src/plugins/projectexplorer/devicesupport/idevicefactory.h b/src/plugins/projectexplorer/devicesupport/idevicefactory.h
index ab4815343d..5f9da63620 100644
--- a/src/plugins/projectexplorer/devicesupport/idevicefactory.h
+++ b/src/plugins/projectexplorer/devicesupport/idevicefactory.h
@@ -42,49 +42,23 @@ QT_END_NAMESPACE
 namespace ProjectExplorer {
 class IDeviceWidget;
 
-/*!
-  \class ProjectExplorer::IDeviceFactory
 
-  \brief Provides an interface for classes providing services related to certain type of device.
-
-  The factory objects have to be added to the global object pool via
-  \c ExtensionSystem::PluginManager::addObject().
-  \sa ExtensionSystem::PluginManager::addObject()
-*/
 class PROJECTEXPLORER_EXPORT IDeviceFactory : public QObject
 {
     Q_OBJECT
 
 public:
-    /*!
-      A short, one-line description of what the device type.
-    */
+
     virtual QString displayNameForId(Core::Id type) const = 0;
-    /*!
-      A list of device types this factory can create.
-    */
+
     virtual QList<Core::Id> availableCreationIds() const = 0;
 
-    /*!
-      Check whether this factory can create new devices. This is used to hide
-      auto-detect-only factories from the listing of possible devices to create.
-     */
     virtual bool canCreate() const;
 
-    /*!
-      Create a new device. This may or may not open a wizard.
-     */
     virtual IDevice::Ptr create(Core::Id id) const = 0;
 
-    /*!
-      Check whether this factory can restore a device from the given serialized state.
-     */
     virtual bool canRestore(const QVariantMap &map) const = 0;
 
-    /*!
-      Loads a device from a serialized state. Will only ever be called if canRestore()
-      returns true for the given map.
-    */
     virtual IDevice::Ptr restore(const QVariantMap &map) const = 0;
 
     static IDeviceFactory *find(Core::Id type);