[certi-cvs] certi RTIA/main.cc RTIG/main.cc

[certi-cvs]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Petr Gotthard <gotthardp>       08/10/18 18:48:16

Modified files:
        RTIA           : main.cc 
        RTIG           : main.cc 

Log message:
        Documentation update.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/RTIA/main.cc?cvsroot=certi&r1=3.22&r2=3.23
http://cvs.savannah.gnu.org/viewcvs/certi/RTIG/main.cc?cvsroot=certi&r1=3.17&r2=3.18

Patches:
Index: RTIA/main.cc
===================================================================
RCS file: /sources/certi/certi/RTIA/main.cc,v
retrieving revision 3.22
retrieving revision 3.23
diff -u -b -r3.22 -r3.23
--- RTIA/main.cc        13 Oct 2008 19:07:30 -0000      3.22
+++ RTIA/main.cc        18 Oct 2008 18:48:16 -0000      3.23
@@ -18,7 +18,7 @@
 // along with this program ; if not, write to the Free Software
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 //
-// $Id: main.cc,v 3.22 2008/10/13 19:07:30 erk Exp $
+// $Id: main.cc,v 3.23 2008/10/18 18:48:16 gotthardp Exp $
 // ----------------------------------------------------------------------------
 
 #include <config.h>
@@ -40,8 +40,9 @@
 /**
  * @defgroup certi_executable_RTIA RTIA
  *
- * RTIA is the RunTime Infrastructure Ambassador. RTIA is launched 
(fork/CreateProcess) by the RTIambassador
- * constructor.
+ * The CERTI RunTime Infrastructure Ambassador (RTIA) is a process
+ * which is usually automatically launched by the federate as soon as its
+ * RTIambassador is created.
  * \par rtia [-v] [-p \<port\>]
  * \par
  * <ul>
@@ -126,4 +127,4 @@
        throw MemoryExhausted("RTIA has exhausted memory error");
 }
 
-// EOF $Id: main.cc,v 3.22 2008/10/13 19:07:30 erk Exp $
+// EOF $Id: main.cc,v 3.23 2008/10/18 18:48:16 gotthardp Exp $

Index: RTIG/main.cc
===================================================================
RCS file: /sources/certi/certi/RTIG/main.cc,v
retrieving revision 3.17
retrieving revision 3.18
diff -u -b -r3.17 -r3.18
--- RTIG/main.cc        19 Jun 2008 13:56:59 -0000      3.17
+++ RTIG/main.cc        18 Oct 2008 18:48:16 -0000      3.18
@@ -57,7 +57,21 @@
 }
 
 // ----------------------------------------------------------------------------
-//! RTIG server entry point.
+/** 
+ * @defgroup certi_executable_RTIG RTIG
+ *
+ * The CERTI RunTime Infrastructure Gateway (RTIG) is a process which
+ * coordinate the HLA simulation with CERTI, there should be at least
+ * one rtig process for each federation. However a single rtig may
+ * be used for several federation.
+ * \par rtig [-v]
+ * \par
+ * <ul>
+ *   <li> \b -v  (optional) verbose, display more information </li>
+ * </ul>
+ *
+ * @ingroup certi_executable
+ */
 int main(int argc, char *argv[])
 {
     RTIG myRTIG;