[certi-cvs] certi/RTIA main.cc

[CERTI CVS commits]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      14/02/28 15:53:34

Modified files:
        RTIA           : main.cc 

Log message:
        Update RTIA doxygen documentation

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/RTIA/main.cc?cvsroot=certi&r1=3.29&r2=3.30

Patches:
Index: main.cc
===================================================================
RCS file: /sources/certi/certi/RTIA/main.cc,v
retrieving revision 3.29
retrieving revision 3.30
diff -u -b -r3.29 -r3.30
--- main.cc     27 Sep 2013 08:20:13 -0000      3.29
+++ main.cc     28 Feb 2014 15:53:34 -0000      3.30
@@ -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.29 2013/09/27 08:20:13 erk Exp $
+// $Id: main.cc,v 3.30 2014/02/28 15:53:34 erk Exp $
 // ----------------------------------------------------------------------------
 
 #include <config.h>
@@ -61,6 +61,10 @@
  *   <li> \b -v  (optional) verbose, display more information </li>
  *   <li> \b -p  (optional) tcp port to be used to communicate with 
FederateAmbassador</li>
  * </ul>
+ * RTIA will try to connect to RTIG process on the machine specified in 
CERTI_HOME
+ * (see \ref certi_user_env) environment variable. If it is void or not set 
then he will
+ * try to connect to localhost. RTIA connect to TCP port specified by 
CERTI_TCP_PORT
+ * and UDP port specified by CERTI_UDP_PORT.
  *
  * @ingroup certi_executable
  */