doxygen: cleanup of doxygen markup tags.

Signed-off-by: Peter Soetens <[email protected]>

Author: Peter Soetens

Doxyfile.in

@@ -599,14 +599,12 @@ RECURSIVE              = YES
 # excluded from the INPUT source files. This way you can easily exclude a 
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = @CMAKE_INSTALL_PREFIX@/include/rtt/impl \
-		         @CMAKE_INSTALL_PREFIX@/include/rtt/boost \
-                         @CMAKE_INSTALL_PREFIX@/include/rtt/os/gnulinux \
-                         @CMAKE_INSTALL_PREFIX@/include/rtt/os/xenomai \
-                         @CMAKE_INSTALL_PREFIX@/include/rtt/os/lxrt \
-                         @CMAKE_INSTALL_PREFIX@/include/rtt/os/ecos \
-                         @CMAKE_INSTALL_PREFIX@/include/rtt/os/macosx \
-                         @CMAKE_INSTALL_PREFIX@/include/rtt/os/win32
+EXCLUDE                = os/gnulinux \
+                         os/xenomai \
+                         os/lxrt \
+                         os/ecos \
+                         os/macosx \
+                         os/win32
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
 # directories that are symbolic links (a Unix filesystem feature) are excluded 
@@ -1240,9 +1238,9 @@ SEARCH_INCLUDES        = YES
 # contain include files that are not input files but should be processed by 
 # the preprocessor.
 
-INCLUDE_PATH           = src/ \
-                         src/os \
-                         src/os/gnulinux
+INCLUDE_PATH           = rtt/ \
+                         rtt/os \
+                         rtt/os/gnulinux
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
 # patterns (like *.h and *.hpp) to filter out the header-files in the 
@@ -1259,7 +1257,7 @@ INCLUDE_FILE_PATTERNS  =
 # undefined via #undef or recursively expanded use the := operator 
 # instead of the = operator.
 
-PREDEFINED             = DOXYGEN
+PREDEFINED             = DOXYGEN RTT_COMPONENT OROCOS_TARGET=gnulinux
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
 # this tag can be used to specify a list of macro names that should be expanded. 

rtt/Attribute.hpp

@@ -50,7 +50,6 @@ namespace RTT
      * It is used to expose a C/C++ variable to the interface of a TaskContext
      * in order to allow plugins or external tools to read and write it.
      * @param T The type of data this attribute holds.
-     * @ingroup CoreLib
      */
     template<typename T>
     class Attribute
@@ -232,7 +231,6 @@ namespace RTT
     /**
      * As opposed to a Attribute, a Constant can not be assigned to a new value
      * after creation.
-     * @ingroup CoreLib
      */
     template<typename T>
     class Constant

rtt/ConfigurationInterface.hpp

@@ -36,8 +36,8 @@
  ***************************************************************************/
 
 
-#ifndef CONFIGURATIONINTERFACE_HPP
-#define CONFIGURATIONINTERFACE_HPP
+#ifndef RTT_CONFIGURATIONINTERFACE_HPP
+#define RTT_CONFIGURATIONINTERFACE_HPP
 
 #include <memory>
 #include <map>
@@ -53,6 +53,9 @@ namespace RTT
      * @brief A class for keeping track of Attribute, Constant
      * and Property objects of a TaskContext.
      * It allows plugins and remote components to browse the attributes and properties of a TaskContext.
+     * @ingroup Services
+     * @ingroup RTTComponentInterface
+     * @ingroup CoreLibProperties
      */
     class RTT_API ConfigurationInterface
     {

rtt/ConnPolicy.cpp

@@ -71,6 +71,9 @@ namespace RTT
     ConnPolicy::ConnPolicy(int type /* = DATA*/, int lock_policy /*= LOCK_FREE*/)
         : type(type), init(false), lock_policy(lock_policy), pull(false), size(0), transport(0), data_size(0) {}
 
+    /** @cond */
+    /** This is dead code. We use the boost::serialization now.
+     */
     bool composeProperty(const PropertyBag& bag, ConnPolicy& result)
     {
         Property<int> i;
@@ -139,6 +142,10 @@ namespace RTT
         }
         return true;
     }
+
+    /** This is dead code. We use the boost::serialization now.
+     * @internal
+     */
     void decomposeProperty(const ConnPolicy& cp, PropertyBag& targetbag)
     {
         log(Debug) <<"Decomposing ConnPolicy..." <<endlog();
@@ -153,5 +160,6 @@ namespace RTT
         targetbag.ownProperty( new Property<int>("data_size","A hint about the data size of a single data sample. Set to zero if unsure.", cp.transport));
         targetbag.ownProperty( new Property<string>("name_id","The name of the connection to be formed.",cp.name_id));
     }
+    /** @endcond */
 
 }

rtt/ConnPolicy.hpp

@@ -41,7 +41,7 @@
 
 #include <string>
 #include "rtt-fwd.hpp"
-#include "rtt-config.h"
+#include "rtt-config.h"
 
 namespace RTT {
 

rtt/DataFlowInterface.hpp

@@ -52,6 +52,8 @@ namespace RTT
     /**
      * The Interface of a TaskContext which exposes its data-flow ports.
      * @ingroup Ports
+     * @ingroup Services
+     * @ingroup RTTComponentInterface
      */
     class RTT_API DataFlowInterface
     {

rtt/Handle.hpp

@@ -62,7 +62,6 @@ namespace RTT
         // not valid !
      }
      @endverbatim
-     * @ingroup CoreLib
      */
 	class RTT_API Handle
 	{

rtt/Operation.hpp

@@ -63,6 +63,7 @@ namespace RTT
      *
      * @param Signature A template parameter that contains the function signature type
      * of the function this operation object will call.
+     * @ingroup Operations
      */
     template<class Signature>
     class Operation

rtt/OperationCaller.hpp

@@ -58,7 +58,7 @@
 namespace RTT
 {
     /**
-     * @defgroup OperationCallers OperationCaller Interface
+     * @defgroup Operations Operation Interface
      * Invoking synchronous and asynchronous methods.
      * @ingroup RTTComponentInterface
      */
@@ -76,7 +76,7 @@ namespace RTT
      * GlobalExecutionEngine is used instead.
      *
      * @ingroup RTTComponentInterface
-     * @ingroup OperationCallers
+     * @ingroup Operations
      */
     template<class SignatureT>
     class OperationCaller

rtt/OperationInterface.hpp

@@ -56,6 +56,8 @@ namespace RTT
     /**
      * @brief Holds all exported operations of a component and is
      * able to produce callers for these operations.
+     * @ingroup Operations
+     * @ingroup Services
      */
     class RTT_API OperationInterface
     {