Fri Aug 4 07:57:12 UTC 2006 Johnny Willemsen <jwillemsen@remedy.nl>

11 files changed, 49 insertions, 35 deletions

diff --git a/ACE/ChangeLog b/ACE/ChangeLog
index 436605b25ba..3ae7761b215 100644
--- a/ACE/ChangeLog
+++ b/ACE/ChangeLog
@@ -1,3 +1,17 @@
+Fri Aug  4 07:57:12 UTC 2006  Johnny Willemsen  <jwillemsen@remedy.nl>
+
+        * ace/Asynch_IO.h:
+        * ace/Event_Handler.h:
+        * ace/Framework_Component_T.h:
+        * ace/Hash_Map_Manager_T.h:
+        * ace/IO_SAP.h:
+        * ace/Local_Tokens.h:
+        * ace/LSOCK_Connector.h:
+        * ace/Map_Manager.h:
+        * ace/Map_T.h:
+        * ace/WFM_Reactor.h:
+          Doxygen improvements
+
 Thu Aug  3 10:39:12 UTC 2006  Johnny Willemsen  <jwillemsen@remedy.nl>
 
         * ace/Connector.h:
diff --git a/ACE/ace/Asynch_IO.h b/ACE/ace/Asynch_IO.h
index e4733562440..0a19a0ba990 100644
--- a/ACE/ace/Asynch_IO.h
+++ b/ACE/ace/Asynch_IO.h
@@ -6,9 +6,9 @@
  *
  *  $Id$
  *
- *  This works on Win32 (#if defined (ACE_WIN32) && !defined
+ *  This works on Win32 (defined (ACE_WIN32) && !defined
  *  (ACE_HAS_WINCE)) platforms and on POSIX4 platforms with {aio_*}
- *  routines (#if defined (ACE_HAS_AIO_CALLS))
+ *  routines (defined (ACE_HAS_AIO_CALLS))
  *
  *  On Win32 platforms, the implementation of
  *  {ACE_Asynch_Transmit_File} and {ACE_Asynch_Accept} are only
diff --git a/ACE/ace/Event_Handler.h b/ACE/ace/Event_Handler.h
index d97a448e5b4..9c2b97b13d7 100644
--- a/ACE/ace/Event_Handler.h
+++ b/ACE/ace/Event_Handler.h
@@ -359,7 +359,7 @@ private:
  * @class ACE_Notification_Buffer
  *
  * @brief Simple wrapper for passing <ACE_Event_Handler *>s and
- * <ACE_Reactor_Mask>s between threads.
+ * ACE_Reactor_Masks between threads.
  */
 class ACE_Export ACE_Notification_Buffer
 {
diff --git a/ACE/ace/Framework_Component_T.h b/ACE/ace/Framework_Component_T.h
index 13440ea88ae..4dacfe77dd9 100644
--- a/ACE/ace/Framework_Component_T.h
+++ b/ACE/ace/Framework_Component_T.h
@@ -26,10 +26,10 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  *
  * @brief This class inherits the interface of the abstract
  * ACE_Framework_Component class and is instantiated with the
- * implementation of the concrete component class <class Concrete>.
+ * implementation of the concrete component class @c class Concrete.
  *
  * This design is similar to the Adapter and Decorator patterns
- * from the ``Gang of Four'' book.  Note that <class Concrete>
+ * from the ``Gang of Four'' book.  Note that @c class Concrete
  * need not inherit from a common class since ACE_Framework_Component
  * provides the uniform virtual interface!  (implementation based on
  * ACE_Dumpable_Adapter in <ace/Dump_T.h>.
diff --git a/ACE/ace/Hash_Map_Manager_T.h b/ACE/ace/Hash_Map_Manager_T.h
index 35b9028e962..62f75162a8f 100644
--- a/ACE/ace/Hash_Map_Manager_T.h
+++ b/ACE/ace/Hash_Map_Manager_T.h
@@ -528,7 +528,7 @@ private:
 /**
  * @class ACE_Hash_Map_Iterator_Base_Ex
  *
- * @brief Base iterator for the <ACE_Hash_Map_Manager_Ex>
+ * @brief Base iterator for the ACE_Hash_Map_Manager_Ex
  *
  * This class factors out common code from its templatized
  * subclasses.
@@ -595,7 +595,7 @@ protected:
 /**
  * @class ACE_Hash_Map_Const_Iterator_Base_Ex
  *
- * @brief Base const iterator for the <ACE_Hash_Map_Manager_Ex>
+ * @brief Base const iterator for the ACE_Hash_Map_Manager_Ex
  *
  * This class factors out common code from its templatized
  * subclasses.
@@ -662,13 +662,13 @@ protected:
 /**
  * @class ACE_Hash_Map_Iterator_Ex
  *
- * @brief Forward iterator for the <ACE_Hash_Map_Manager_Ex>.
+ * @brief Forward iterator for the ACE_Hash_Map_Manager_Ex.
  *
  * This class does not perform any internal locking of the
- * <ACE_Hash_Map_Manager_Ex> it is iterating upon since locking is
+ * ACE_Hash_Map_Manager_Ex it is iterating upon since locking is
  * inherently inefficient and/or error-prone within an STL-style
  * iterator.  If you require locking, you can explicitly use an
- * ACE_Guard or ACE_Read_Guard on the <ACE_Hash_Map_Manager_Ex>'s
+ * ACE_Guard or ACE_Read_Guard on the ACE_Hash_Map_Manager_Ex's
  * internal lock, which is accessible via its <mutex> method.
  */
 template <class EXT_ID, class INT_ID, class HASH_KEY, class COMPARE_KEYS, class ACE_LOCK>
@@ -708,13 +708,13 @@ public:
 /**
  * @class ACE_Hash_Map_Const_Iterator_Ex
  *
- * @brief Const forward iterator for the <ACE_Hash_Map_Manager_Ex>.
+ * @brief Const forward iterator for the ACE_Hash_Map_Manager_Ex.
  *
  * This class does not perform any internal locking of the
- * <ACE_Hash_Map_Manager_Ex> it is iterating upon since locking is
+ * ACE_Hash_Map_Manager_Ex it is iterating upon since locking is
  * inherently inefficient and/or error-prone within an STL-style
  * iterator.  If you require locking, you can explicitly use an
- * ACE_Guard or ACE_Read_Guard on the <ACE_Hash_Map_Manager_Ex>'s
+ * ACE_Guard or ACE_Read_Guard on the ACE_Hash_Map_Manager_Ex's
  * internal lock, which is accessible via its <mutex> method.
  */
 template <class EXT_ID, class INT_ID, class HASH_KEY, class COMPARE_KEYS, class ACE_LOCK>
@@ -754,15 +754,15 @@ public:
 /**
  * @class ACE_Hash_Map_Bucket_Iterator
  *
- * @brief Forward iterator for the <ACE_Hash_Map_Manager_Ex> which
+ * @brief Forward iterator for the ACE_Hash_Map_Manager_Ex which
  * only traverses a particular bucket.  The particular bucket is
  * specified by the <EXT_ID> parameter specified in the constructor.
  *
  * This class does not perform any internal locking of the
- * <ACE_Hash_Map_Manager_Ex> it is iterating upon since locking is
+ * ACE_Hash_Map_Manager_Ex it is iterating upon since locking is
  * inherently inefficient and/or error-prone within an STL-style
  * iterator.  If you require locking, you can explicitly use an
- * ACE_Guard or ACE_Read_Guard on the <ACE_Hash_Map_Manager_Ex>'s
+ * ACE_Guard or ACE_Read_Guard on the ACE_Hash_Map_Manager_Ex's
  * internal lock, which is accessible via its <mutex> method.
  *
  * Note that a creation method for this new iterator cannot be added
@@ -830,13 +830,13 @@ protected:
 /**
  * @class ACE_Hash_Map_Reverse_Iterator_Ex
  *
- * @brief Reverse iterator for the <ACE_Hash_Map_Manager_Ex>.
+ * @brief Reverse iterator for the ACE_Hash_Map_Manager_Ex.
  *
  * This class does not perform any internal locking of the
- * <ACE_Hash_Map_Manager_Ex> it is iterating upon since locking is
+ * ACE_Hash_Map_Manager_Ex it is iterating upon since locking is
  * inherently inefficient and/or error-prone within an STL-style
  * iterator.  If you require locking, you can explicitly use an
- * ACE_Guard or ACE_Read_Guard on the <ACE_Hash_Map_Manager_Ex>'s
+ * ACE_Guard or ACE_Read_Guard on the ACE_Hash_Map_Manager_Ex's
  * internal lock, which is accessible via its <mutex> method.
  */
 template <class EXT_ID, class INT_ID, class HASH_KEY, class COMPARE_KEYS, class ACE_LOCK>
@@ -918,7 +918,7 @@ class ACE_Hash_Map_Manager : public ACE_Hash_Map_Manager_Ex<EXT_ID, INT_ID, ACE_
 {
 public:
 
-  /** 
+  /**
    * Initialize a @c Hash_Map_Manager with default size elements.
    * @param table_alloc is a pointer to a memory allocator used for
    *        table_, so it should supply size*sizeof (ACE_Hash_Map_Entry<EXT_ID, INT_ID>).
@@ -932,7 +932,7 @@ public:
   ACE_Hash_Map_Manager (ACE_Allocator *table_alloc = 0,
                         ACE_Allocator *entry_alloc = 0);
 
-  /** 
+  /**
    * Initialize a @c Hash_Map_Manager with @c size elements.
    * @param table_alloc is a pointer to a memory allocator used for
    *        table_, so it should supply size*sizeof (ACE_Hash_Map_Entry<EXT_ID, INT_ID>).
diff --git a/ACE/ace/IO_SAP.h b/ACE/ace/IO_SAP.h
index b4ed13e451c..d6f4f1bf044 100644
--- a/ACE/ace/IO_SAP.h
+++ b/ACE/ace/IO_SAP.h
@@ -28,7 +28,7 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
 /**
  * @class ACE_IO_SAP
  *
- * @brief Defines the methods for the base class of the <ACE_IO_SAP>
+ * @brief Defines the methods for the base class of the ACE_IO_SAP
  * abstraction, which includes <ACE_FILE> and <ACE_DEV>.
  */
 class ACE_Export ACE_IO_SAP
diff --git a/ACE/ace/LSOCK_Connector.h b/ACE/ace/LSOCK_Connector.h
index a362a1587d4..4c4008edca6 100644
--- a/ACE/ace/LSOCK_Connector.h
+++ b/ACE/ace/LSOCK_Connector.h
@@ -32,7 +32,7 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  * @class ACE_LSOCK_Connector
  *
  * @brief Defines the format and interface for the connector side of
- * the <ACE_LSOCK_Stream>.
+ * the ACE_LSOCK_Stream.
  */
 class ACE_Export ACE_LSOCK_Connector : public ACE_SOCK_Connector
 {
diff --git a/ACE/ace/Local_Tokens.h b/ACE/ace/Local_Tokens.h
index 1351f73f49f..454df8082db 100644
--- a/ACE/ace/Local_Tokens.h
+++ b/ACE/ace/Local_Tokens.h
@@ -685,7 +685,7 @@ protected:
  * @brief Allows Token_Manger to identify tokens.
  *
  * For now, this is just a string.  We need a string class
- * anyway to use in <ACE_Map_Manager>.  Having this class
+ * anyway to use in ACE_Map_Manager.  Having this class
  * (instead of <ACE_SString>) allows us to easily change if
  * needed.  For instance, we may choose to identify tokens by
  * name and *type* in the future.
diff --git a/ACE/ace/Map_Manager.h b/ACE/ace/Map_Manager.h
index cc92a385c53..bb8dc30b39e 100644
--- a/ACE/ace/Map_Manager.h
+++ b/ACE/ace/Map_Manager.h
@@ -405,7 +405,7 @@ protected:
   /// Pointer to a memory allocator.
   ACE_Allocator *allocator_;
 
-  /// Synchronization variable for the MT_SAFE <ACE_Map_Manager>.
+  /// Synchronization variable for the MT_SAFE ACE_Map_Manager.
   mutable ACE_LOCK lock_;
 
   /// Implement the Map as a resizeable array of <ACE_Map_Entry>.
@@ -562,10 +562,10 @@ protected:
  * @brief Forward iterator for the ACE_Map_Manager.
  *
  * This class does not perform any internal locking of the
- * <ACE_Map_Manager> it is iterating upon since locking is
+ * ACE_Map_Manager it is iterating upon since locking is
  * inherently inefficient and/or error-prone within an STL-style
  * iterator.  If you require locking, you can explicitly use an
- * ACE_Guard or ACE_Read_Guard on the <ACE_Map_Manager>'s
+ * ACE_Guard or ACE_Read_Guard on the ACE_Map_Manager's
  * internal lock, which is accessible via its <mutex> method.
  */
 template <class EXT_ID, class INT_ID, class ACE_LOCK>
@@ -609,10 +609,10 @@ public:
  * @brief Forward const iterator for the ACE_Map_Manager.
  *
  * This class does not perform any internal locking of the
- * <ACE_Map_Manager> it is iterating upon since locking is
+ * ACE_Map_Manager it is iterating upon since locking is
  * inherently inefficient and/or error-prone within an STL-style
  * iterator.  If you require locking, you can explicitly use an
- * ACE_Guard or ACE_Read_Guard on the <ACE_Map_Manager>'s
+ * ACE_Guard or ACE_Read_Guard on the ACE_Map_Manager's
  * internal lock, which is accessible via its <mutex> method.
  */
 template <class EXT_ID, class INT_ID, class ACE_LOCK>
@@ -653,13 +653,13 @@ public:
 /**
  * @class ACE_Map_Reverse_Iterator
  *
- * @brief Reverse Iterator for the <ACE_Map_Manager>.
+ * @brief Reverse Iterator for the ACE_Map_Manager.
  *
  * This class does not perform any internal locking of the
- * <ACE_Map_Manager> it is iterating upon since locking is
+ * ACE_Map_Manager it is iterating upon since locking is
  * inherently inefficient and/or error-prone within an STL-style
  * iterator.  If you require locking, you can explicitly use an
- * ACE_Guard or ACE_Read_Guard on the <ACE_Map_Manager>'s
+ * ACE_Guard or ACE_Read_Guard on the ACE_Map_Manager's
  * internal lock, which is accessible via its <mutex> method.
  */
 template <class EXT_ID, class INT_ID, class ACE_LOCK>
diff --git a/ACE/ace/Map_T.h b/ACE/ace/Map_T.h
index 942b8bf1156..6f982ecf6f3 100644
--- a/ACE/ace/Map_T.h
+++ b/ACE/ace/Map_T.h
@@ -1118,7 +1118,7 @@ protected:
  *
  * @brief Defines a map implementation.
  *
- * Implementation to be provided by <ACE_Hash_Map_Manager_Ex>.
+ * Implementation to be provided by ACE_Hash_Map_Manager_Ex.
  */
 template <class KEY, class VALUE, class HASH_KEY, class COMPARE_KEYS, class KEY_GENERATOR>
 class ACE_Hash_Map_Manager_Ex_Adapter : public ACE_Map<KEY, VALUE>
@@ -1404,7 +1404,7 @@ protected:
  *
  * @brief Defines a map implementation.
  *
- * Implementation to be provided by <ACE_Map_Manager>.
+ * Implementation to be provided by ACE_Map_Manager.
  */
 template <class KEY, class VALUE, class KEY_GENERATOR>
 class ACE_Map_Manager_Adapter : public ACE_Map<KEY, VALUE>
diff --git a/ACE/ace/WFMO_Reactor.h b/ACE/ace/WFMO_Reactor.h
index 8e3cdb4cc28..079201b77dd 100644
--- a/ACE/ace/WFMO_Reactor.h
+++ b/ACE/ace/WFMO_Reactor.h
@@ -489,7 +489,7 @@ protected:
  * <WaitForMultipleObjects> when updates occur other than in the
  * main <ACE_WFMO_Reactor> thread.  To do this, we signal an
  * auto-reset event the <ACE_WFMO_Reactor> is listening on.  If
- * an ACE_Event_Handler and <ACE_Reactor_Mask> is passed to
+ * an ACE_Event_Handler and ACE_Reactor_Mask is passed to
  * <notify>, the appropriate <handle_*> method is dispatched.
  */
 class ACE_Export ACE_WFMO_Reactor_Notify : public ACE_Reactor_Notify