[certi-cvs] certi/RTIG Federation.cc Federation.hh

[certi-cvs]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      09/09/16 07:55:58

Modified files:
        RTIG           : Federation.cc Federation.hh 

Log message:
        Suppress some doxygen warning

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/RTIG/Federation.cc?cvsroot=certi&r1=3.109&r2=3.110
http://cvs.savannah.gnu.org/viewcvs/certi/RTIG/Federation.hh?cvsroot=certi&r1=3.57&r2=3.58

Patches:
Index: Federation.cc
===================================================================
RCS file: /sources/certi/certi/RTIG/Federation.cc,v
retrieving revision 3.109
retrieving revision 3.110
diff -u -b -r3.109 -r3.110
--- Federation.cc       14 Sep 2009 21:21:32 -0000      3.109
+++ Federation.cc       16 Sep 2009 07:55:58 -0000      3.110
@@ -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: Federation.cc,v 3.109 2009/09/14 21:21:32 erk Exp $
+// $Id: Federation.cc,v 3.110 2009/09/16 07:55:58 erk Exp $
 // ----------------------------------------------------------------------------
 
 #include <config.h>
@@ -1455,10 +1455,8 @@
 }
 
 // ----------------------------------------------------------------------------
-//! Return true if federate is in federation.
-/*! Return true if the Federate is part of the Federation, else throw an
-  exception.
-*/
+// Return true if federate is in federation.
+
 bool
 Federation::check(FederateHandle federate_handle) const
     throw (FederateNotExecutionMember)
@@ -2582,5 +2580,5 @@
 
 }} // namespace certi/rtig
 
-// $Id: Federation.cc,v 3.109 2009/09/14 21:21:32 erk Exp $
+// $Id: Federation.cc,v 3.110 2009/09/16 07:55:58 erk Exp $
 

Index: Federation.hh
===================================================================
RCS file: /sources/certi/certi/RTIG/Federation.hh,v
retrieving revision 3.57
retrieving revision 3.58
diff -u -b -r3.57 -r3.58
--- Federation.hh       16 Dec 2008 07:08:29 -0000      3.57
+++ Federation.hh       16 Sep 2009 07:55:58 -0000      3.58
@@ -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: Federation.hh,v 3.57 2008/12/16 07:08:29 approx Exp $
+// $Id: Federation.hh,v 3.58 2009/09/16 07:55:58 erk Exp $
 // ----------------------------------------------------------------------------
 
 #ifndef _CERTI_RTIG_FEDERATION_HH
@@ -135,6 +135,13 @@
     bool empty() const
         throw (FederatesCurrentlyJoined);
 
+    /**
+     * Check whether if the federate is part of the federation.
+     * @param[in] theHandle
+     * @return true if the federate is part of the Federation,
+     *              else throw an exception.
+     * @throws FederateNotExecutionMember
+     */
     bool check(FederateHandle theHandle) const
         throw (FederateNotExecutionMember);
 
@@ -677,4 +684,4 @@
 
 #endif // _CERTI_RTIG_FEDERATION_HH
 
-// $Id: Federation.hh,v 3.57 2008/12/16 07:08:29 approx Exp $
+// $Id: Federation.hh,v 3.58 2009/09/16 07:55:58 erk Exp $