1 files changed, 42 insertions, 41 deletions

diff --git a/TAO/tao/Fault_Tolerance_Service.h b/TAO/tao/Fault_Tolerance_Service.h
index 6a489b6c8fc..28abe861bae 100644
--- a/TAO/tao/Fault_Tolerance_Service.h
+++ b/TAO/tao/Fault_Tolerance_Service.h
@@ -1,22 +1,19 @@
 //-*- C++ -*-
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-//    TAO
-//
-// = FILENAME
-//    Fault_Tolerance_Service.h
-//
-// = DESCRIPTION
-//    A collection of the ORB and ORB core related properties that are
-//    specific to FT service. The TAO_ORB_Core holds an instance of this
-//    class.
-//
-// = AUTHOR
-//   Bala Natarajan <bala@cs.wustl.edu>
-// ============================================================================
+//=============================================================================
+/**
+ *  @file    Fault_Tolerance_Service.h
+ *
+ *  $Id$
+ *
+ *  A collection of the ORB and ORB core related properties that are
+ *  specific to FT service. The TAO_ORB_Core holds an instance of this
+ *  class.
+ *
+ *
+ *  @author Bala Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
 
 #ifndef TAO_FAULT_TOLERANCE_SERVICE_H
 #define TAO_FAULT_TOLERANCE_SERVICE_H
@@ -41,56 +38,60 @@
 class TAO_Service_Callbacks;
 class TAO_ORB_Core;
 
+/**
+ * @class TAO_Fault_Tolerance_Service
+ *
+ * @brief TAO_Fault_Tolerant_Service
+ *
+ * A collection of ORB & ORB_Core related stuff that is needed at
+ * the ORB level. The ORB Core would carry an instance of this
+ * class and invoke methods on this.
+ * Note: This collection would be really useful when we have
+ * logging in  place. The contents of this class can be logged at
+ * regular check point intervals.
+ */
 class TAO_Export TAO_Fault_Tolerance_Service
 {
-  // = TITLE
-  //    TAO_Fault_Tolerant_Service
-  //
-  // = DESCRIPTION
-  //    A collection of ORB & ORB_Core related stuff that is needed at
-  //    the ORB level. The ORB Core would carry an instance of this
-  //    class and invoke methods on this.
-  //    Note: This collection would be really useful when we have
-  //    logging in  place. The contents of this class can be logged at
-  //    regular check point intervals.
 
 public:
+  /// Ctor
   TAO_Fault_Tolerance_Service (void);
-  // Ctor
 
+  /// Dtor
   ~TAO_Fault_Tolerance_Service (void);
-  // Dtor
 
+  /// Initialise the internal data structures
   void init (TAO_ORB_Core *orb_core);
-  // Initialise the internal data structures
 
+  /// Return the underlying callback object
   TAO_Service_Callbacks *service_callback (void);
-  // Return the underlying callback object
 
+  /// Return the underlying <ft_object_id>
   const ACE_CString &client_id (void);
-  // Return the underlying <ft_object_id>
 
+  /// Set the client id
   void client_id (const char *id);
-  // Set the client id
 
+  /// Generate and return a new retention id
   CORBA::Long retention_id (void);
-  // Generate and return a new retention id
 
 private:
 
+  /// hook to callback on to the service
   TAO_Service_Callbacks *ft_service_callback_;
-  // hook to callback on to the service
 
+  /// The object id that would be used if the ft service is loaded.
   ACE_CString ft_object_id_;
-  // The object id that would be used if the ft service is loaded.
 
+  /**
+   * This and the <ft_object_id_> act as unique identifiers for the
+   * request sent from the source Object. Modification of this value
+   * is done by the loaded FT
+   */
   CORBA::Long ft_object_retention_id_;
-  // This and the <ft_object_id_> act as unique identifiers for the
-  // request sent from the source Object. Modification of this value
-  // is done by the loaded FT
 
+  /// Lock for the retention id
   ACE_Lock *ft_object_retention_id_lock_;
-  // Lock for the retention id
 
   // NOTE: At a glance this retention id can be easily mistaken for a
   // request id in a GIOP request. But the purpose served are a lot