[certi-cvs] certi/include RTI.hh

[CERTI CVS commits]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      11/12/31 13:24:00

Modified files:
        include        : RTI.hh 

Log message:
        some more documentation

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/include/RTI.hh?cvsroot=certi&r1=3.19&r2=3.20

Patches:
Index: RTI.hh
===================================================================
RCS file: /sources/certi/certi/include/RTI.hh,v
retrieving revision 3.19
retrieving revision 3.20
diff -u -b -r3.19 -r3.20
--- RTI.hh      26 Apr 2011 11:07:38 -0000      3.19
+++ RTI.hh      31 Dec 2011 13:24:00 -0000      3.20
@@ -1,5 +1,5 @@
 // HLA 1.3 Header "RTI.hh"
-// $Id: RTI.hh,v 3.19 2011/04/26 11:07:38 erk Exp $
+// $Id: RTI.hh,v 3.20 2011/12/31 13:24:00 erk Exp $
 
 #ifndef RTI_hh
 #define RTI_hh
@@ -62,6 +62,10 @@
 
        /**
         * RTI (RunTime Infrastructure) Ambassador class.
+        * The RTIambassador class is the interface used by an
+        * HLA federate to call the RTI. The RTI may call the
+        * federate back using the Federate Ambassador class
+        * @see FederateAmbassador.
         */
     class RTI_EXPORT RTIambassador
     {
@@ -74,6 +78,9 @@
 
     /**
      * Federate Ambassador class.
+     * The FederateAmbassador is the structure RTI callback class.
+     * When the RTI needs to contact the federate it calls one
+     * of the FederateAmbassador class methods.
      */
     class RTI_EXPORT FederateAmbassador
     {