[certi-cvs] certi doc/CMakeLists.txt doc/certi_user.cnf.in ...

[certi-cvs]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      08/10/13 19:07:30

Modified files:
        doc            : CMakeLists.txt certi_user.cnf.in certi_user.dox 
        RTIA           : main.cc 
        libCERTI       : Clock.hh 

Log message:
        Add an example of \defgroup and \copydoc for Petr

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/doc/CMakeLists.txt?cvsroot=certi&r1=1.9&r2=1.10
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user.cnf.in?cvsroot=certi&r1=3.4&r2=3.5
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user.dox?cvsroot=certi&r1=3.3&r2=3.4
http://cvs.savannah.gnu.org/viewcvs/certi/RTIA/main.cc?cvsroot=certi&r1=3.21&r2=3.22
http://cvs.savannah.gnu.org/viewcvs/certi/libCERTI/Clock.hh?cvsroot=certi&r1=4.7&r2=4.8

Patches:
Index: doc/CMakeLists.txt
===================================================================
RCS file: /sources/certi/certi/doc/CMakeLists.txt,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- doc/CMakeLists.txt  13 Oct 2008 14:32:35 -0000      1.9
+++ doc/CMakeLists.txt  13 Oct 2008 19:07:30 -0000      1.10
@@ -32,7 +32,7 @@
                            DOC_TYPE    "html;pdf"
                            OUTPUT_DIR ${CMAKE_BINARY_DIR}/doc/Install
                            COMMENTS "CERTI installation documentation"
-                           VERBOSE)                           
+                           )                           
   ENDIF (BUILD_DOC_INSTALL)
   
   #user documentation

Index: doc/certi_user.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_user.cnf.in,v
retrieving revision 3.4
retrieving revision 3.5
diff -u -b -r3.4 -r3.5
--- doc/certi_user.cnf.in       13 Oct 2008 14:32:35 -0000      3.4
+++ doc/certi_user.cnf.in       13 Oct 2008 19:07:30 -0000      3.5
@@ -436,7 +436,8 @@
 
 INPUT                  = "${CMAKE_SOURCE_DIR}/doc/certi_user_doc.tree" \
                          "${CMAKE_SOURCE_DIR}/doc/certi_introduction.dox" \
-                         "${CMAKE_SOURCE_DIR}/doc/certi_user.dox"
+                         "${CMAKE_SOURCE_DIR}/doc/certi_user.dox" \
+                         "${CMAKE_SOURCE_DIR}/RTIA/main.cc" 
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -1026,7 +1027,7 @@
 # in the modules index. If set to NO, only the current project's groups will 
 # be listed.
 
-EXTERNAL_GROUPS        = YES
+EXTERNAL_GROUPS        = NO
 
 # The PERL_PATH should be the absolute path and name of the perl script 
 # interpreter (i.e. the result of `which perl').

Index: doc/certi_user.dox
===================================================================
RCS file: /sources/certi/certi/doc/certi_user.dox,v
retrieving revision 3.3
retrieving revision 3.4
diff -u -b -r3.3 -r3.4
--- doc/certi_user.dox  13 Oct 2008 14:32:36 -0000      3.3
+++ doc/certi_user.dox  13 Oct 2008 19:07:30 -0000      3.4
@@ -58,7 +58,10 @@
  * one rtig process for each federation. However a single rtig may
  * be used for several federation.
  *
- * \subsection certi_user_rtia
+ * \subsection certi_user_rtia RTIA CERTI RunTime Infrastructure Ambassador 
aka RTIA
+ *
+ * \copydoc certi_executable_RTIA
+ *
  * The CERTI RunTime Infrastructure Ambassador (RTIA) is a process
  * which is automatically launched by any federate as soon as its
  * RTIambassador is created.

Index: RTIA/main.cc
===================================================================
RCS file: /sources/certi/certi/RTIA/main.cc,v
retrieving revision 3.21
retrieving revision 3.22
diff -u -b -r3.21 -r3.22
--- RTIA/main.cc        23 Jun 2008 12:49:15 -0000      3.21
+++ RTIA/main.cc        13 Oct 2008 19:07:30 -0000      3.22
@@ -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.21 2008/06/23 12:49:15 erk Exp $
+// $Id: main.cc,v 3.22 2008/10/13 19:07:30 erk Exp $
 // ----------------------------------------------------------------------------
 
 #include <config.h>
@@ -37,7 +37,20 @@
 void NewHandler();
 int normal_end;
 
-// ----------------------------------------------------------------------------
+/**
+ * @defgroup certi_executable_RTIA RTIA
+ *
+ * RTIA is the RunTime Infrastructure Ambassador. RTIA is launched 
(fork/CreateProcess) by the RTIambassador
+ * constructor.
+ * \par rtia [-v] [-p \<port\>]
+ * \par
+ * <ul>
+ *   <li> \b -v  (optional) verbose, display more information </li>
+ *   <li> \b -p  (optional) tcp port to be used to communicate with 
FederateAmbassador</li>
+ * </ul>
+ *
+ * @ingroup certi_executable
+ */
 int 
 main(int argc, char **argv) {
        signal(SIGINT, SignalHandler);
@@ -113,4 +126,4 @@
        throw MemoryExhausted("RTIA has exhausted memory error");
 }
 
-// EOF $Id: main.cc,v 3.21 2008/06/23 12:49:15 erk Exp $
+// EOF $Id: main.cc,v 3.22 2008/10/13 19:07:30 erk Exp $

Index: libCERTI/Clock.hh
===================================================================
RCS file: /sources/certi/certi/libCERTI/Clock.hh,v
retrieving revision 4.7
retrieving revision 4.8
diff -u -b -r4.7 -r4.8
--- libCERTI/Clock.hh   10 Oct 2008 07:34:54 -0000      4.7
+++ libCERTI/Clock.hh   13 Oct 2008 19:07:30 -0000      4.8
@@ -20,7 +20,15 @@
 #ifndef CLOCK_HH_
 #define CLOCK_HH_
 
+
+
+#include <string>
+#include "certi.hh"
+
+namespace certi {
+
 /**
+ * An abstract Clock class.
  * Clock abstraction which tries to use high-resolution
  * system clock in order to be able to help user to
  * profile it's application using simple clock API.
@@ -29,12 +37,6 @@
  * http://www.opengroup.org/onlinepubs/000095399/functions/clock_getres.html
  * or other hardware assisted clock like Pentium TSC.
  */
-
-#include <string>
-#include "certi.hh"
-
-namespace certi {
-
 class CERTI_EXPORT Clock
 {
 public: