[certi-cvs] certi/include CMakeLists.txt hla-1_3/RTIambServ...

[CERTI CVS commits]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      14/03/03 14:24:56

Modified files:
        include        : CMakeLists.txt 
        include/hla-1_3: RTIambServices.hh CMakeLists.txt 

Log message:
        Enhance HLA 1.3 API documentation.
        This is a long running and painful job.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/include/CMakeLists.txt?cvsroot=certi&r1=1.7&r2=1.8
http://cvs.savannah.gnu.org/viewcvs/certi/include/hla-1_3/RTIambServices.hh?cvsroot=certi&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/certi/include/hla-1_3/CMakeLists.txt?cvsroot=certi&r1=1.1&r2=1.2

Patches:
Index: CMakeLists.txt
===================================================================
RCS file: /sources/certi/certi/include/CMakeLists.txt,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- CMakeLists.txt      9 Dec 2013 13:47:56 -0000       1.7
+++ CMakeLists.txt      3 Mar 2014 14:24:56 -0000       1.8
@@ -1,4 +1,4 @@
-# Install version specific headers
+# Process version specific headers
 add_subdirectory(hla-1_3)
 add_subdirectory(ieee1516-2000)
 add_subdirectory(ieee1516-2010)

Index: hla-1_3/RTIambServices.hh
===================================================================
RCS file: /sources/certi/certi/include/hla-1_3/RTIambServices.hh,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- hla-1_3/RTIambServices.hh   9 Dec 2013 13:47:58 -0000       1.1
+++ hla-1_3/RTIambServices.hh   3 Mar 2014 14:24:56 -0000       1.2
@@ -9,14 +9,33 @@
  * @{
  */
 
+/**
+ * Create the federation execution.
+ * @param[in] executionName, the name of the federation to be created
+ * @param[in] FEDid, the file path to the Federation Execution Data file, 
a.k.a. FED file.
+ *            this file can be an XML file or a "fed" file.
+ * @exception FederationExecutionAlreadyExists the RTI has already registered 
a federation with the same name
+ * @exception CouldNotOpenFED the FED (Federation Execution Data) file cannot 
be found or read properly (check RTIG log output)
+ * @exception ErrorReadingFED
+ * @exception ConcurrentAccessAttempted
+ * @exception RTIinternalError
+ */
 void createFederationExecution(const char *executionName, const char *FEDid)
     throw (FederationExecutionAlreadyExists, CouldNotOpenFED, ErrorReadingFED,
           ConcurrentAccessAttempted, RTIinternalError);
 
-void destroyFederationExecution(const char *)
+/**
+ * Destroys the federation execution.
+ * @param[in] executionName the name of the federation
+ */
+void destroyFederationExecution(const char *executionName)
     throw (FederatesCurrentlyJoined, FederationExecutionDoesNotExist,
           ConcurrentAccessAttempted, RTIinternalError);
 
+/**
+ * Joins the federation execution.
+ * 
+ */
 FederateHandle joinFederationExecution(const char *, const char *, 
FederateAmbassadorPtr)
     throw (FederateAlreadyExecutionMember, FederationExecutionDoesNotExist,
           CouldNotOpenFED, ErrorReadingFED, ConcurrentAccessAttempted,

Index: hla-1_3/CMakeLists.txt
===================================================================
RCS file: /sources/certi/certi/include/hla-1_3/CMakeLists.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- hla-1_3/CMakeLists.txt      9 Dec 2013 13:47:58 -0000       1.1
+++ hla-1_3/CMakeLists.txt      3 Mar 2014 14:24:56 -0000       1.2
@@ -2,7 +2,7 @@
 # like RTI_VERSION, RTI_INTERNAL_VERSION etc...
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/RTItypes.hh.cmake 
${CMAKE_CURRENT_BINARY_DIR}/RTItypes.hh)
 # Install public HLA 1.3 DLC headers files
-INSTALL(FILES
+install(FILES
   NullFederateAmbassador.hh
   RTI.hh
   RTIambServices.hh