certi-cvs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[certi-cvs] certi/doc certi_user_doc.tree certi_user_header...


From: certi-cvs
Subject: [certi-cvs] certi/doc certi_user_doc.tree certi_user_header...
Date: Mon, 13 Oct 2008 14:32:36 +0000

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      08/10/13 14:32:36

Modified files:
        doc            : certi_user_doc.tree certi_user_header.html 
                         CMakeLists.txt index.html doc_install.in 
                         certi_user.cnf.in DoxyTools.cmake 
                         certi_developer_doc.tree certi_user.dox 
                         certi_install_doc.tree 
                         certi_install_header.html 
                         certi_developer.cnf.in 
Removed files:
        doc            : certi_doc_tree.dox 

Log message:
        Hopefully working doxygen documentation generation system.
        PDF output needs improvement, however the idea are there

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user_doc.tree?cvsroot=certi&r1=3.2&r2=3.3
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user_header.html?cvsroot=certi&r1=3.1&r2=3.2
http://cvs.savannah.gnu.org/viewcvs/certi/doc/CMakeLists.txt?cvsroot=certi&r1=1.8&r2=1.9
http://cvs.savannah.gnu.org/viewcvs/certi/doc/index.html?cvsroot=certi&r1=3.5&r2=3.6
http://cvs.savannah.gnu.org/viewcvs/certi/doc/doc_install.in?cvsroot=certi&r1=3.1&r2=3.2
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user.cnf.in?cvsroot=certi&r1=3.3&r2=3.4
http://cvs.savannah.gnu.org/viewcvs/certi/doc/DoxyTools.cmake?cvsroot=certi&r1=3.3&r2=3.4
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_developer_doc.tree?cvsroot=certi&r1=3.1&r2=3.2
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user.dox?cvsroot=certi&r1=3.2&r2=3.3
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install_doc.tree?cvsroot=certi&r1=3.2&r2=3.3
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install_header.html?cvsroot=certi&r1=3.1&r2=3.2
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_developer.cnf.in?cvsroot=certi&r1=3.2&r2=3.3
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_doc_tree.dox?cvsroot=certi&r1=1.4&r2=0

Patches:
Index: certi_user_doc.tree
===================================================================
RCS file: /sources/certi/certi/doc/certi_user_doc.tree,v
retrieving revision 3.2
retrieving revision 3.3
diff -u -b -r3.2 -r3.3
--- certi_user_doc.tree 11 Oct 2008 23:03:17 -0000      3.2
+++ certi_user_doc.tree 13 Oct 2008 14:32:35 -0000      3.3
@@ -31,8 +31,8 @@
  * The installation documentation is divided into several part:
  * 
  * <ul>
- *  <li>Section \ref intro</li>
- *  <li>Section \ref user</li>
+ *  <li>\ref intro</li>
+ *  <li>\ref user</li>
  * </ul> 
  *
  */

Index: certi_user_header.html
===================================================================
RCS file: /sources/certi/certi/doc/certi_user_header.html,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- certi_user_header.html      11 Oct 2008 23:03:17 -0000      3.1
+++ certi_user_header.html      13 Oct 2008 14:32:35 -0000      3.2
@@ -2,4 +2,5 @@
 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
 <title>$title</title>
 <link href="$relpath$certi.css" rel="stylesheet" type="text/css">
+<a href="$relpath$index.html"> Back to CERTI User Documentation index</a>
 </head><body>

Index: CMakeLists.txt
===================================================================
RCS file: /sources/certi/certi/doc/CMakeLists.txt,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -b -r1.8 -r1.9
--- CMakeLists.txt      11 Oct 2008 23:03:17 -0000      1.8
+++ CMakeLists.txt      13 Oct 2008 14:32:35 -0000      1.9
@@ -1,5 +1,6 @@
 IF (BUILD_DOC)
     FIND_PACKAGE(Doxygen)
+    FIND_PACKAGE(LATEX)
     IF (DOXYGEN_FOUND)
     LIST(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}")
     INCLUDE(DoxyTools)

Index: index.html
===================================================================
RCS file: /sources/certi/certi/doc/index.html,v
retrieving revision 3.5
retrieving revision 3.6
diff -u -b -r3.5 -r3.6
--- index.html  11 Oct 2008 23:03:17 -0000      3.5
+++ index.html  13 Oct 2008 14:32:35 -0000      3.6
@@ -1,8 +1,14 @@
 <h1>CERTI Available documentation set</h1>
 <p> Note that you may have only a part of this set installed </p>
 <ul>
-<li><a href="Install/html/index.html">CERTI Installation documentation</a></li>
-<li><a href="User/html/index.html">CERTI User documentation</a></li>
+ <li>
+    <a href="Install/html/index.html">CERTI Installation documentation</a> 
+    <a href="Install/CERTI_Install.pdf"> (PDF Version)</a> 
+ </li>
+ <li>
+    <a href="User/html/index.html">CERTI User documentation</a>
+    <a href="User/CERTI_User.pdf">(PDF Version)</a>
+  </li>
 <li><a href="Developer/html/index.html">CERTI Developer documentation</a></li>
 </ul>
 

Index: doc_install.in
===================================================================
RCS file: /sources/certi/certi/doc/doc_install.in,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- doc_install.in      11 Oct 2008 23:03:17 -0000      3.1
+++ doc_install.in      13 Oct 2008 14:32:35 -0000      3.2
@@ -1,2 +1,13 @@
-MESSAGE(STATUS "Now installing doc set <@DOCSET@> ...")
-EXECUTE_PROCESS(COMMAND @CMAKE_COMMAND@ -E copy_directory 
@DoxyTools_OUTPUT_DIR@ @CMAKE_INSTALL_PREFIX@/share/doc/certi/@DOCSET@)
\ No newline at end of file
+MESSAGE(STATUS "Now installing Doc set <@DOCSET@> ...")
+SET(HTMLGEN @genhtml@)
+IF (HTMLGEN)
+   MESSAGE(STATUS "Installing HTML output for Doc set <@DOCSET@>...")
+   EXECUTE_PROCESS(COMMAND @CMAKE_COMMAND@ -E copy_directory 
@DoxyTools_OUTPUT_DIR@/html 
@CMAKE_INSTALL_PREFIX@/share/doc/certi/@DOCSET@/html)
+ENDIF (HTMLGEN)
+
+SET(PDFGEN @genpdf@)
+IF (PDFGEN)
+       MESSAGE(STATUS "Installing PDF output for Doc set <@DOCSET@>...")
+       EXECUTE_PROCESS(COMMAND @CMAKE_COMMAND@ -E copy 
@DoxyTools_OUTPUT_DIR@/latex/refman.pdf 
@CMAKE_INSTALL_PREFIX@/share/doc/certi/@DOCSET@/address@hidden@.pdf)
+ENDIF (PDFGEN)
+MESSAGE(STATUS "Doc set <@DOCSET@> installed.")
\ No newline at end of file

Index: certi_user.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_user.cnf.in,v
retrieving revision 3.3
retrieving revision 3.4
diff -u -b -r3.3 -r3.4
--- certi_user.cnf.in   11 Oct 2008 23:03:17 -0000      3.3
+++ certi_user.cnf.in   13 Oct 2008 14:32:35 -0000      3.4
@@ -711,12 +711,12 @@
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
 # put in front of it. If left blank `latex' will be used as the default path.
 
-LATEX_OUTPUT           = pdflatex
+LATEX_OUTPUT           = latex
 
 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
 # invoked. If left blank `latex' will be used as the default command name.
 
-LATEX_CMD_NAME         = latex
+LATEX_CMD_NAME         = pdflatex
 
 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
 # generate index for LaTeX. If left blank `makeindex' will be used as the 

Index: DoxyTools.cmake
===================================================================
RCS file: /sources/certi/certi/doc/DoxyTools.cmake,v
retrieving revision 3.3
retrieving revision 3.4
diff -u -b -r3.3 -r3.4
--- DoxyTools.cmake     11 Oct 2008 23:03:18 -0000      3.3
+++ DoxyTools.cmake     13 Oct 2008 14:32:35 -0000      3.4
@@ -105,6 +105,16 @@
        COMMAND ${CMAKE_COMMAND} -E echo "Done."
        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
        
+    # If genpdf was specified AND a pdflatex compiler was found
+    # then create a rule for running pdflatex
+    IF(genpdf AND PDFLATEX_COMPILER)
+        ADD_CUSTOM_TARGET(${DOCSET}_doc_forced_pdf
+           COMMAND ${CMAKE_COMMAND} -E echo_append "Building CERTI ${DOCSET} 
PDF Documentation..."       
+           COMMAND ${PDFLATEX_COMPILER} refman.tex
+           COMMAND ${CMAKE_COMMAND} -E echo "Done."
+           WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/${DOCSET}/latex)      
             
+    ENDIF(genpdf AND PDFLATEX_COMPILER)
+    
     IF (genhtml)
        MESSAGE(STATUS "Will install ${DoxyTools_OUTPUT_DIR}")
        CONFIGURE_FILE(doc_install.in ${DOCSET}_doc_install.cmake)

Index: certi_developer_doc.tree
===================================================================
RCS file: /sources/certi/certi/doc/certi_developer_doc.tree,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- certi_developer_doc.tree    9 Oct 2008 23:39:57 -0000       3.1
+++ certi_developer_doc.tree    13 Oct 2008 14:32:35 -0000      3.2
@@ -24,27 +24,18 @@
  
 /**
  * @mainpage
- * \section intro_sec Introduction
+ * \section certi_devel CERTI Developer documentation
  *
- * This is the CERTI documentation.
- * CERTI is an Open Source HLA compliant  
- * <a href="http://en.wikipedia.org/wiki/Run-Time_Infrastructure_(simulation)">
- * RunTime Infrastructure (RTI)</a>.
- * You'll find hereafter the documentation for the main modules
- * of the CERTI project.
- * CERTI is primarily developed and maintained by the Toulouse research center 
of ONERA [http://www.onera.fr], the French Aerospace Labs. 
- * The primary goal of CERTI is to be used in research activities but CERTI 
has a growing
- * number of users and contributors among the CERTI Open Source community.
- * 
- * People interested in CERTI may join the CERTI Open Source
- * community at <a href="https://savannah.nongnu.org/projects/certi";>
- * https://savannah.nongnu.org/projects/certi </a> and/or
- * by using the mailing list 
- * <a href="http://lists.nongnu.org/mailman/listinfo/certi-devel";>
- * http://lists.nongnu.org/mailman/listinfo/certi-devel </a>
- * for discussion regarding CERTI usage.
+ * This is the CERTI Developer documentation. The developer
+ * documentation is divided into the following part:
+ * <ul>
+ *  <li>\ref intro </li>
+ *  <li>\ref install </li>
+ *  <li>\ref user </li>
+ *  <li>\ref certi_modules </li>
+ * </ul> 
  *
- * \section certi_modules Main CERTI Modules
+ * \section certi_modules Main CERTI Developer Modules
  * The main CERTI modules are:
  * <ul>
  *   <li> \ref libCERTI </li>
@@ -57,66 +48,6 @@
  *   <li> \ref libHLA </li>
  * </ul>
  * 
- * \section certi_sdk Installing and using CERTI SDK
- * 
- * CERTI SDK comes as either as an installer (binary) or compressed tar source 
archives.
- * The primary distribution format is gzip compressed tar source archive 
(.tar.gz)
- * or ZIP archive (.zip) and may be found on Savannah CERTI download area: <a 
href="http://download.savannah.nongnu.org/releases/certi/";> 
http://download.savannah.nongnu.org/releases/certi/ </a>.
- *
- * CERTI build system uses  <a href="http://www.cmake.org/";>CMake,  
http://www.cmake.org/ </a>
- * which is a cross-platform build system generator. CMake should be used to 
- * compile CERTI SDK on a variety of platform/compiler combination like:
- * <ul>
- *   <li> Linux x86 / gcc </li>
- *   <li> Linux x86_64 / gcc </li>
- *   <li> Solaris Sparc / Sun Studio </li>
- *   <li> Windows / Visual Studio </li>
- *   <li> Windows / Code::Blocks+MinGW </li>
- *   <li> ... </li>
- * </ul>
- * 
- * You may follow generic CMake usage instruction for building CERTI
- * on various platforms:  <a 
href="http://www.cmake.org/cmake/help/runningcmake.html";>Running CMake,  
http://www.cmake.org/cmake/help/runningcmake.html://www.cmake.org/ </a>
- * or you may try to follow the below CERTI CMake usage.
- * 
- * \subsection certi_sdk_TARGZ Tarball based SDK
- * 
- * If you get a tarball source CERTI distribution such as you may found in the 
download 
- * section of the Savannah project 
- * <a>http://download.savannah.nongnu.org/releases/certi/</a>, 
- * you should follow these steps: 
- * <ol>
- * <li>untar the archive: tar zxvf certi-\<version\>-Source.tar.gz 
- *     this should create a certi-\<version\>-Source directory
- * </li>
- * \verbatim
- tar zxvf certi-3.2.4-Source.tar.gz
- ... wait for tar ending ... \endverbatim
- * <li>Prepare separate build directory and run CMake
- * </li>
- * \verbatim
- mkdir build_certi
- cd build_certi
- cmake -DCMAKE_INSTALL_PREFIX=/path/to/install 
/path/to/certi-\<version\>-Source
- ... wait for cmake run  ending ... \endverbatim
- * <li>compile your certi</li>
- * \verbatim
- make
- ... wait the compilation end ... \endverbatim
- <li> Then you may either install CERTI or build
-      a binary package that will be usable for installation</li>
- <ul>
- * <li>install CERTI</li>
- * \verbatim
- make install
- ... wait for make install end ... \endverbatim
- * <li>build your binary package </li>
- * \verbatim
- make package \endverbatim
- </ul>
- * </ol>
- * After that you will have a compiled and usable CERTI package.
- *  
  */
 
 /**

Index: certi_user.dox
===================================================================
RCS file: /sources/certi/certi/doc/certi_user.dox,v
retrieving revision 3.2
retrieving revision 3.3
diff -u -b -r3.2 -r3.3
--- certi_user.dox      11 Oct 2008 23:03:18 -0000      3.2
+++ certi_user.dox      13 Oct 2008 14:32:36 -0000      3.3
@@ -1,7 +1,66 @@
 /**
- * \page install Using CERTI 
+ * \page user Using CERTI 
  *
- * \addindex using
+ * \addindex user
+ *  
+ * CERTI comes as a set of libraries and binaries executables, which may
+ * be used to build an HLA compliant simulation.
+ *
+ * \section certi_user_running Running an HLA simulation with CERTI
+ * \subsection certi_user_layout CERTI installation layout
+ * CERTI components are installed in a user-chosen CERTI_HOME
+ * directory. Below this root directory the layout is as described below:
+ * \dot
+ *   digraph certi_layout {
+ *      node [shape=record, fontname=Helvetica, fontsize=10];
+ *      home [ label="CERTI_HOME"];
+ *      bin [ label="bin"];
+ *      lib [ label="lib"];
+ *      share [ label="share"];
+ *      doc [label="doc"];
+ *      federations [label="federations"];
+ *      home -> bin [ arrowhead="open", style="solid" ];
+ *      home -> lib [ arrowhead="open", style="solid" ];
+ *      home -> share [ arrowhead="open", style="solid" ];
+ *      share -> doc [ arrowhead="open", style="solid" ];
+ *      share -> federations [ arrowhead="open", style="solid" ];
+ *   }
+ * \enddot
+ *
+ * \section certi_user_env CERTI environment variables
+ * 
+ * CERTI uses a set of environment variables which may influence its 
+ * execution behavior.
+ * <center>
+ * <TABLE>
+ * <tr>
+ * <td><b>Variable</b></td><td><b>Component</b></td><td><b>Description</b></td>
+ * </tr>
+ * <tr>
+ * <td>CERTI_HOST</td> <td>RTIA</td><td>machine on which RTIG is running</td>
+ * </tr>
+ * <tr>
+ * <td>CERTI_TCP_PORT</td> <td>RTIG, RTIA</td> <td>TCP port used for RTIA/RTIG 
communications</td>
+ * </tr>
+ * <tr>
+ * <td>CERTI_UDP_PORT</td> <td>RTIG, RTIA</td> <td>UDP port used for RTIA/RTIG 
communications</td>
+ * </tr>
+ * <tr> <td>CERTI_NO_STATISTICS</td> <td>RTIA</td> <td>if set, do not display 
service calls statistics</td>
+ * </tr>
+ * </TABLE>
+ * </center>
+ * 
+ * \section certi_user_executables CERTI executables
+ * CERTI comes with mainly 2 executables:
+ * \subsection certi_user_rtig CERTI RunTime Infrastructure Gateway aka 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.
+ *
+ * \subsection certi_user_rtia
+ * The CERTI RunTime Infrastructure Ambassador (RTIA) is a process
+ * which is automatically launched by any federate as soon as its
+ * RTIambassador is created.
  *  
- * Using CERTI blah blah ....
  */

Index: certi_install_doc.tree
===================================================================
RCS file: /sources/certi/certi/doc/certi_install_doc.tree,v
retrieving revision 3.2
retrieving revision 3.3
diff -u -b -r3.2 -r3.3
--- certi_install_doc.tree      10 Oct 2008 12:37:06 -0000      3.2
+++ certi_install_doc.tree      13 Oct 2008 14:32:36 -0000      3.3
@@ -31,8 +31,8 @@
  * The installation documentation is divided into several part:
  * 
  * <ul>
- *  <li>Section \ref intro</li>
- *  <li>Section \ref install</li>
+ *  <li>\ref intro</li>
+ *  <li>\ref install</li>
  * </ul> 
  *
  */

Index: certi_install_header.html
===================================================================
RCS file: /sources/certi/certi/doc/certi_install_header.html,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- certi_install_header.html   10 Oct 2008 12:37:06 -0000      3.1
+++ certi_install_header.html   13 Oct 2008 14:32:36 -0000      3.2
@@ -2,4 +2,5 @@
 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
 <title>$title</title>
 <link href="$relpath$certi.css" rel="stylesheet" type="text/css">
+<a href="$relpath$index.html"> Back to CERTI Installation Documentation index 
</a>
 </head><body>

Index: certi_developer.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_developer.cnf.in,v
retrieving revision 3.2
retrieving revision 3.3
diff -u -b -r3.2 -r3.3
--- certi_developer.cnf.in      11 Oct 2008 21:40:16 -0000      3.2
+++ certi_developer.cnf.in      13 Oct 2008 14:32:36 -0000      3.3
@@ -434,7 +434,8 @@
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = "${CMAKE_BINARY_DIR}/include" \
+INPUT                  = "${CMAKE_SOURCE_DIR}/doc/certi_developer_doc.tree" \
+                         "${CMAKE_BINARY_DIR}/include" \
                             "${CMAKE_SOURCE_DIR}/include" \                    
             
                          "${CMAKE_SOURCE_DIR}/libCERTI" \
                          "${CMAKE_SOURCE_DIR}/libRTI" \
@@ -450,8 +451,7 @@
 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 
*.hxx 
 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
 
-FILE_PATTERNS          = *.cc *.hh \
-                                                       *.dox \ 
+FILE_PATTERNS          = *.cc *.hh *.dox
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
 # should be searched for input files as well. Possible values are YES and NO. 

Index: certi_doc_tree.dox
===================================================================
RCS file: certi_doc_tree.dox
diff -N certi_doc_tree.dox
--- certi_doc_tree.dox  7 Oct 2008 21:03:41 -0000       1.4
+++ /dev/null   1 Jan 1970 00:00:00 -0000
@@ -1,158 +0,0 @@
-/* -*- c -*- 
-// ----------------------------------------------------------------------------
-// CERTI - HLA RunTime Infrastructure
-// Copyright (C) 2002, 2003, 2004  ONERA
-//
-// This file is part of CERTI
-//
-// CERTI-libCERTI is free software ; you can redistribute it and/or
-// modify it under the terms of the GNU Lesser General Public License
-// as published by the Free Software Foundation ; either version 2 of
-// the License, or (at your option) any later version.
-//
-// CERTI-libCERTI is distributed in the hope that it will be useful, but
-// WITHOUT ANY WARRANTY ; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-// Lesser General Public License for more details.
-//
-// You should have received a copy of the GNU Lesser General Public
-// License along with this program ; if not, write to the Free Software
-// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-// USA
-// ----------------------------------------------------------------------------
-*/
- 
-/**
- * @mainpage
- * \section intro_sec Introduction
- *
- * This is the CERTI documentation.
- * CERTI is an Open Source HLA compliant  
- * <a href="http://en.wikipedia.org/wiki/Run-Time_Infrastructure_(simulation)">
- * RunTime Infrastructure (RTI)</a>.
- * You'll find hereafter the documentation for the main modules
- * of the CERTI project.
- * CERTI is primarily developed and maintained by the Toulouse research center 
of ONERA [http://www.onera.fr], the French Aerospace Labs. 
- * The primary goal of CERTI is to be used in research activities but CERTI 
has a growing
- * number of users and contributors among the CERTI Open Source community.
- * 
- * People interested in CERTI may join the CERTI Open Source
- * community at <a href="https://savannah.nongnu.org/projects/certi";>
- * https://savannah.nongnu.org/projects/certi </a> and/or
- * by using the mailing list 
- * <a href="http://lists.nongnu.org/mailman/listinfo/certi-devel";>
- * http://lists.nongnu.org/mailman/listinfo/certi-devel </a>
- * for discussion regarding CERTI usage.
- *
- * \section certi_modules Main CERTI Modules
- * The main CERTI modules are:
- * <ul>
- *   <li> \ref libCERTI </li>
- *   <li> \ref libRTI </li>
- *   <li> \ref Billard_Application </li> 
- * </ul>
- * There are some RTI-agnostic libraries or applications which
- * are bundled with the CERTI distribution:
- * <ul>
- *   <li> \ref libHLA </li>
- * </ul>
- * 
- * \section certi_sdk Installing and using CERTI SDK
- * 
- * CERTI SDK comes as either as an installer (binary) or compressed tar source 
archives.
- * The primary distribution format is gzip compressed tar source archive 
(.tar.gz)
- * or ZIP archive (.zip) and may be found on Savannah CERTI download area: <a 
href="http://download.savannah.nongnu.org/releases/certi/";> 
http://download.savannah.nongnu.org/releases/certi/ </a>.
- *
- * CERTI build system uses  <a href="http://www.cmake.org/";>CMake,  
http://www.cmake.org/ </a>
- * which is a cross-platform build system generator. CMake should be used to 
- * compile CERTI SDK on a variety of platform/compiler combination like:
- * <ul>
- *   <li> Linux x86 / gcc </li>
- *   <li> Linux x86_64 / gcc </li>
- *   <li> Solaris Sparc / Sun Studio </li>
- *   <li> Windows / Visual Studio </li>
- *   <li> Windows / Code::Blocks+MinGW </li>
- *   <li> ... </li>
- * </ul>
- * 
- * You may follow generic CMake usage instruction for building CERTI
- * on various platforms:  <a 
href="http://www.cmake.org/cmake/help/runningcmake.html";>Running CMake,  
http://www.cmake.org/cmake/help/runningcmake.html://www.cmake.org/ </a>
- * or you may try to follow the below CERTI CMake usage.
- * 
- * \subsection certi_sdk_TARGZ Tarball based SDK
- * 
- * If you get a tarball source CERTI distribution such as you may found in the 
download 
- * section of the Savannah project 
- * <a>http://download.savannah.nongnu.org/releases/certi/</a>, 
- * you should follow these steps: 
- * <ol>
- * <li>untar the archive: tar zxvf certi-\<version\>-Source.tar.gz 
- *     this should create a certi-\<version\>-Source directory
- * </li>
- * \verbatim
- tar zxvf certi-3.2.4-Source.tar.gz
- ... wait for tar ending ... \endverbatim
- * <li>Prepare separate build directory and run CMake
- * </li>
- * \verbatim
- mkdir build_certi
- cd build_certi
- cmake -DCMAKE_INSTALL_PREFIX=/path/to/install 
/path/to/certi-\<version\>-Source
- ... wait for cmake run  ending ... \endverbatim
- * <li>compile your certi</li>
- * \verbatim
- make
- ... wait the compilation end ... \endverbatim
- <li> Then you may either install CERTI or build
-      a binary package that will be usable for installation</li>
- <ul>
- * <li>install CERTI</li>
- * \verbatim
- make install
- ... wait for make install end ... \endverbatim
- * <li>build your binary package </li>
- * \verbatim
- make package \endverbatim
- </ul>
- * </ol>
- * After that you will have a compiled and usable CERTI package.
- *  
- */
-
-/**
- * @defgroup certi CERT Run Time Infrastructure (CERTI)
- * The CERTI is an Open Source HLA Run Time Infrastructure (RTI)
- * primarily developed by the Toulouse Center of ONERA
- * (http://www.onera.fr)  
- * The CERTI itself consists in a set of libraries and tests applications.
- * @see HLA_Libraries the (normative) HLA Run Time Libraries
- * @see HLA_Helpers_Libraries some RTI-agnostic HLA Helper Libraries 
- * @see CERTI_Libraries the private CERTI library. 
- * @see CERTI_Applications Some applications bundled with CERTI.
- * More informations on
- * <A 
HREF="http://savannah.nongnu.org/projects/certi";>http://savannah.nongnu.org/projects/certi</A>.
- */
-  
-/**
- * @defgroup HLA_Libraries Normatives HLA libraries
- * This group of libraries contains the HLA/IEEE-1516 compliant normative 
libraries.
- */
-
-/**
- * @defgroup CERTI_Libraries The CERTI libraries
- * The CERTI programming libraries.
- * @ingroup certi
- */
- 
-/**
- * @defgroup HLA_Helper_Libraries NON-normative HLA helper libraries
- * This group of libraries contains helper libraries which are non normative
- * and may be used to ease the development of an HLA federate. 
- * Those libraries are RTI agnostic, they may be used with other RTI than 
CERTI.
- * @ingroup certi
- */
- 
-/**
- * @defgroup CERTI_Applications Applications bundled with CERTI.
- * @ingroup certi
- */




reply via email to

[Prev in Thread] Current Thread [Next in Thread]