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

1 files changed, 67 insertions, 60 deletions

diff --git a/ace/Cleanup_Strategies_T.h b/ace/Cleanup_Strategies_T.h
index 1dd43239e27..337e30bd9fe 100644
--- a/ace/Cleanup_Strategies_T.h
+++ b/ace/Cleanup_Strategies_T.h
@@ -1,18 +1,15 @@
 /* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//    ace
-//
-// = FILENAME
-//    Cleanup_Strategies_T.h
-//
-// = AUTHOR
-//    Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ *  @file    Cleanup_Strategies_T.h
+ *
+ *  $Id$
+ *
+ *  @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
 
 #ifndef CLEANUP_STRATEGIES_H
 #define CLEANUP_STRATEGIES_H
@@ -27,106 +24,116 @@
 // For linkers that cant grok long names.
 #define ACE_Cleanup_Strategy ACLE
 
+/**
+ * @class ACE_Cleanup_Strategy
+ *
+ * @brief Defines a default strategy to be followed for cleaning up
+ * entries from a map which is the container.
+ *
+ * By default the entry to be cleaned up is removed from the
+ * container.
+ */
 template <class KEY, class VALUE, class CONTAINER>
 class ACE_Cleanup_Strategy
 {
-  // = TITLE
-  //     Defines a default strategy to be followed for cleaning up
-  //     entries from a map which is the container.
-  //
-  // = DESCRIPTION
-  //     By default the entry to be cleaned up is removed from the
-  //     container.
 
 public:
 
+  /// The method which will do the cleanup of the entry in the container.
   virtual int cleanup (CONTAINER &container, KEY *key, VALUE *value);
-  // The method which will do the cleanup of the entry in the container.
 };
 
 //////////////////////////////////////////////////////////////////////
 #define ACE_Recyclable_Handler_Cleanup_Strategy ARHCLE
 
+/**
+ * @class ACE_Recyclable_Handler_Cleanup_Strategy
+ *
+ * @brief Defines a strategy to be followed for cleaning up
+ * entries which are svc_handlers from a container.
+ *
+ * The entry to be cleaned up is removed from the container.
+ * Here, since we are dealing with svc_handlers specifically, we
+ * perform a couple of extra operations. Note: To be used when
+ * the handler is recyclable.
+ */
 template <class KEY, class VALUE, class CONTAINER>
 class ACE_Recyclable_Handler_Cleanup_Strategy : public ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER>
 {
-  // = TITLE
-  //     Defines a strategy to be followed for cleaning up
-  //     entries which are svc_handlers from a container.
-  //
-  // = DESCRIPTION
-  //     The entry to be cleaned up is removed from the container.
-  //     Here, since we are dealing with svc_handlers specifically, we
-  //     perform a couple of extra operations. Note: To be used when
-  //     the handler is recyclable.
 
 public:
 
+  /// The method which will do the cleanup of the entry in the container.
   virtual int cleanup (CONTAINER &container, KEY *key, VALUE *value);
-  // The method which will do the cleanup of the entry in the container.
 };
 
 //////////////////////////////////////////////////////////////////////
 #define ACE_Refcounted_Recyclable_Handler_Cleanup_Strategy ARRHCLE
 
+/**
+ * @class ACE_Refcounted_Recyclable_Handler_Cleanup_Strategy
+ *
+ * @brief Defines a strategy to be followed for cleaning up
+ * entries which are svc_handlers from a container.
+ *
+ * The entry to be cleaned up is removed from the container.
+ * Here, since we are dealing with recyclable svc_handlers with
+ * addresses which are refcountable specifically, we perform a
+ * couple of extra operations and do so without any locking.
+ */
 template <class KEY, class VALUE, class CONTAINER>
 class ACE_Refcounted_Recyclable_Handler_Cleanup_Strategy : public ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER>
 {
-  // = TITLE
-  //     Defines a strategy to be followed for cleaning up
-  //     entries which are svc_handlers from a container.
-  //
-  // = DESCRIPTION
-  //     The entry to be cleaned up is removed from the container.
-  //     Here, since we are dealing with recyclable svc_handlers with
-  //     addresses which are refcountable specifically, we perform a
-  //     couple of extra operations and do so without any locking. 
 
 public:
 
+  /// The method which will do the cleanup of the entry in the container.
   virtual int cleanup (CONTAINER &container, KEY *key, VALUE *value);
-  // The method which will do the cleanup of the entry in the container.
 };
 
 //////////////////////////////////////////////////////////////////////
 
+/**
+ * @class ACE_Handler_Cleanup_Strategy
+ *
+ * @brief Defines a strategy to be followed for cleaning up
+ * entries which are svc_handlers from a container.
+ *
+ * The entry to be cleaned up is removed from the container.
+ * Here, since we are dealing with svc_handlers specifically, we
+ * perform a couple of extra operations. Note: This cleanup strategy
+ * should be used in the case when the handler has the caching
+ * attributes.
+ */
 template <class KEY, class VALUE, class CONTAINER>
 class ACE_Handler_Cleanup_Strategy : public ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER>
 {
-  // = TITLE
-  //     Defines a strategy to be followed for cleaning up
-  //     entries which are svc_handlers from a container.
-  //
-  // = DESCRIPTION
-  //     The entry to be cleaned up is removed from the container.
-  //     Here, since we are dealing with svc_handlers specifically, we
-  //     perform a couple of extra operations. Note: This cleanup strategy
-  //     should be used in the case when the handler has the caching
-  //     attributes.
 
 public:
 
+  /// The method which will do the cleanup of the entry in the container.
   virtual int cleanup (CONTAINER &container, KEY *key, VALUE *value);
-  // The method which will do the cleanup of the entry in the container.
 };
 
 //////////////////////////////////////////////////////////////////////
 #define ACE_Null_Cleanup_Strategy ANCLE
 
+/**
+ * @class ACE_Null_Cleanup_Strategy
+ *
+ * @brief Defines a do-nothing implementation of the cleanup strategy.
+ *
+ * This class simply does nothing at all! Can be used to nullify
+ * the effect of the Cleanup Strategy.
+ */
 template <class KEY, class VALUE, class CONTAINER>
 class ACE_Null_Cleanup_Strategy : public ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER>
 {
-  // = TITLE
-  //     Defines a do-nothing implementation of the cleanup strategy.
-  //
-  // = DESCRIPTION
-  //     This class simply does nothing at all! Can be used to nullify
-  //     the effect of the Cleanup Strategy.
 
 public:
 
+  /// The dummy cleanup method.
   virtual int cleanup (CONTAINER &container, KEY *key, VALUE *value);
-  // The dummy cleanup method.
 };
 
 #if defined (ACE_TEMPLATES_REQUIRE_SOURCE)