[certi-cvs] certi/include RTI/RTIambassador.h RTI.hh

[certi-cvs]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      10/11/20 18:10:12

Modified files:
        include/RTI    : RTIambassador.h 
        include        : RTI.hh 

Log message:
        Improve API documentation with doxygen

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/include/RTI/RTIambassador.h?cvsroot=certi&r1=1.2&r2=1.3
http://cvs.savannah.gnu.org/viewcvs/certi/include/RTI.hh?cvsroot=certi&r1=3.17&r2=3.18

Patches:
Index: RTI/RTIambassador.h
===================================================================
RCS file: /sources/certi/certi/include/RTI/RTIambassador.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- RTI/RTIambassador.h 31 May 2010 12:29:44 -0000      1.2
+++ RTI/RTIambassador.h 20 Nov 2010 18:10:12 -0000      1.3
@@ -24,6 +24,9 @@
 
 namespace rti1516
 {
+  /**
+   * RTI (RunTime Infrastructure) Ambassador class.
+   */
   class RTI_EXPORT RTIambassador
   {
   protected:
@@ -35,6 +38,11 @@
       ~RTIambassador();
     // throw ()
 
+    /**
+     * @defgroup IEEE1516_FederationManagement Federation Management
+     * @ingroup  IEEE1516_RTI_Ambassador
+     * @{
+     */
     // 4.2
     virtual void createFederationExecution
     (std::wstring const & federationExecutionName,
@@ -172,6 +180,8 @@
              SaveInProgress,
              RTIinternalError) = 0;
 
+    /** @} end group IEEE1516_FederationManagement */
+
     /////////////////////////////////////
     // Declaration Management Services //
     /////////////////////////////////////

Index: RTI.hh
===================================================================
RCS file: /sources/certi/certi/include/RTI.hh,v
retrieving revision 3.17
retrieving revision 3.18
diff -u -b -r3.17 -r3.18
--- RTI.hh      24 Nov 2009 21:44:48 -0000      3.17
+++ RTI.hh      20 Nov 2010 18:10:12 -0000      3.18
@@ -1,5 +1,5 @@
 // HLA 1.3 Header "RTI.hh"
-// $Id: RTI.hh,v 3.17 2009/11/24 21:44:48 erk Exp $
+// $Id: RTI.hh,v 3.18 2010/11/20 18:10:12 erk Exp $
 
 #ifndef RTI_hh
 #define RTI_hh
@@ -49,6 +49,9 @@
 #include "baseTypes.hh"
 #include "RTItypes.hh"
 
+       /**
+        * RTI (RunTime Infrastructure) Ambassador class.
+        */
     class RTI_EXPORT RTIambassador
     {
     public:
@@ -58,6 +61,9 @@
        RTIambPrivateRefs* privateRefs ;
     };
 
+    /**
+     * Federate Ambassador class.
+     */
     class RTI_EXPORT FederateAmbassador
     {
     public: