ChangeLogTag:Wed Nov 1 14:11:48 2000 Carlos O'Ryan <coryan@uci.edu>

1 files changed, 45 insertions, 44 deletions

diff --git a/ace/Active_Map_Manager.h b/ace/Active_Map_Manager.h
index 7395cf68f9d..1911e6c7e2e 100644
--- a/ace/Active_Map_Manager.h
+++ b/ace/Active_Map_Manager.h
@@ -1,18 +1,15 @@
 /* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//    ace
-//
-// = FILENAME
-//    Active_Map_Manager.h
-//
-// = AUTHOR
-//    Irfan Pyarali
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ *  @file    Active_Map_Manager.h
+ *
+ *  $Id$
+ *
+ *  @author Irfan Pyarali
+ */
+//=============================================================================
+
 
 #ifndef ACE_ACTIVE_MAP_MANAGER_H
 #define ACE_ACTIVE_MAP_MANAGER_H
@@ -24,74 +21,78 @@
 # pragma once
 #endif /* ACE_LACKS_PRAGMA_ONCE */
 
+/**
+ * @class ACE_Active_Map_Manager_Key
+ *
+ * @brief Key used in the Active Object Map.
+ *
+ * This key keeps information of the index and the generation
+ * count of the slot it represents.  Since the index information
+ * is part of the key, lookups are super fast and predictable,
+ */
 class ACE_Export ACE_Active_Map_Manager_Key
 {
-  // = TITLE
-  //     Key used in the Active Object Map.
-  //
-  // = DESCRIPTION
-  //     This key keeps information of the index and the generation
-  //     count of the slot it represents.  Since the index information
-  //     is part of the key, lookups are super fast and predictable,
 public:
+  /// Default constructor.
   ACE_Active_Map_Manager_Key (void);
-  // Default constructor.
 
+  /**
+   * Constructor given the <slot_index> and <slot_generation> number.
+   * This is useful once the user has somehow recovered the
+   * <slot_index> and <slot_generation> number from the client.
+   */
   ACE_Active_Map_Manager_Key (ACE_UINT32 slot_index,
                               ACE_UINT32 slot_generation);
-  // Constructor given the <slot_index> and <slot_generation> number.
-  // This is useful once the user has somehow recovered the
-  // <slot_index> and <slot_generation> number from the client.
 
+  /// Get/Set the <slot_index>.
   ACE_UINT32 slot_index (void) const;
   void slot_index (ACE_UINT32 i);
-  // Get/Set the <slot_index>.
 
+  /// Get/Set the <slot_generation> number.
   ACE_UINT32 slot_generation (void) const;
   void slot_generation (ACE_UINT32 g);
-  // Get/Set the <slot_generation> number.
 
+  /// Size required to store information about active key.
   static size_t size (void);
-  // Size required to store information about active key.
 
+  /// Recover state of active key from <data>.  User must make sure
+  /// that <data> encoded using the <encode> method.
   void decode (const void *data);
-  // Recover state of active key from <data>.  User must make sure
-  // that <data> encoded using the <encode> method.
 
+  /// Encode state of the active key into <data>.  <data> must be as
+  /// big as the value returned from <size>.
   void encode (void *data) const;
-  // Encode state of the active key into <data>.  <data> must be as
-  // big as the value returned from <size>.
 
+  /// Compare keys.
   int operator== (const ACE_Active_Map_Manager_Key &rhs) const;
   int operator!= (const ACE_Active_Map_Manager_Key &rhs) const;
-  // Compare keys.
 
   // = This really should be protected but because of template
   // friends, they are not.
 
+  /// Increment the <slot_generation> number.
   void increment_slot_generation_count (void);
-  // Increment the <slot_generation> number.
 
 private:
 
+  /**
+   * @brief Data for the Active Object Map Key.
+   *
+   * This separate structure makes it easier to manage copying
+   *  the index and the generation to and from the user buffer.
+   *
+   */
   struct key_data
   {
-    // = TITLE
-    //     Data for the Active Object Map Key.
-    //
-    // = DESCRIPTION
-    //     This separate structure makes it easier to manage copying
-    //     the index and the generation to and from the user buffer.
-
+    /// Slot index in the active map.
     ACE_UINT32 slot_index_;
-    // Slot index in the active map.
 
+    /// Slot generation number of <slot_index_> slot in the active map.
     ACE_UINT32 slot_generation_;
-    // Slot generation number of <slot_index_> slot in the active map.
   };
 
+  /// Data for the Active Object Map Key.
   key_data key_data_;
-  // Data for the Active Object Map Key.
 };
 
 #if defined (__ACE_INLINE__)