Mon Oct 22 18:57:15 UTC 2007 Johnny Willemsen <jwillemsen@remedy.nl>

16 files changed, 84 insertions, 66 deletions

diff --git a/ACE/ChangeLog b/ACE/ChangeLog
index b8c28318639..d4551c2af71 100644
--- a/ACE/ChangeLog
+++ b/ACE/ChangeLog
@@ -1,3 +1,22 @@
+Mon Oct 22 18:57:15 UTC 2007  Johnny Willemsen  <jwillemsen@remedy.nl>
+
+        * ace/POSIX_Asynch_IO.h:
+        * ace/RW_Process_Mutex.h:
+        * ace/SOCK_Acceptor.h:
+        * ace/SOCK_Dgram.h:
+        * ace/SOCK_IO.h:
+        * ace/SOCK_SEQPACK_Acceptor.h:
+        * ace/SOCK_SEQPACK_Association.h:
+        * ace/SPIPE_Connector.h:
+        * ace/Task.h:
+        * ace/Thread.h:
+        * ace/Thread_Hook.h:
+        * ace/TLI_Connector.h:
+        * ace/UPIPE_Connector.h:
+        * ace/UPIPE_Stream.h:
+        * ace/XTI_ATM_Mcast.h:
+          Doxygen changes
+
 Mon Oct 22 18:53:15 UTC 2007  Johnny Willemsen  <jwillemsen@remedy.nl>
 
         * ace/Asynch_Connector.{h,cpp}:
diff --git a/ACE/ace/POSIX_Asynch_IO.h b/ACE/ace/POSIX_Asynch_IO.h
index 927b9fe06cf..91bcd8b0285 100644
--- a/ACE/ace/POSIX_Asynch_IO.h
+++ b/ACE/ace/POSIX_Asynch_IO.h
@@ -1063,7 +1063,7 @@ public:
    * @a message_block beginning at its write pointer. The @a message_block
    * write pointer will be updated to reflect any added bytes if the read
    * operation is successful completed.
-   * Priority of the operation is specified by <priority>. On POSIX4-Unix,
+   * Priority of the operation is specified by @a priority. On POSIX4-Unix,
    * this is supported. Works like <nice> in Unix. Negative values are not
    * allowed. 0 means priority of the operation same as the process
    * priority. 1 means priority of the operation is one less than
diff --git a/ACE/ace/RW_Process_Mutex.h b/ACE/ace/RW_Process_Mutex.h
index 6242d81f43c..83ae034a40c 100644
--- a/ACE/ace/RW_Process_Mutex.h
+++ b/ACE/ace/RW_Process_Mutex.h
@@ -43,7 +43,7 @@ class ACE_Export ACE_RW_Process_Mutex
 {
 public:
   /// Create a readers/writer <Process_Mutex>, passing in the optional
-  /// @a name, <flags> and <mode> \sa ACE_File_Lock.
+  /// @a name, @a flags and @a mode \sa ACE_File_Lock.
   ///  If not specified, a name is generated and flags and mode are set
   ///  to default platform values.
 #if defined (ACE_WIN32)
diff --git a/ACE/ace/SOCK_Acceptor.h b/ACE/ace/SOCK_Acceptor.h
index 951cd47c138..2bab34f1aad 100644
--- a/ACE/ace/SOCK_Acceptor.h
+++ b/ACE/ace/SOCK_Acceptor.h
@@ -68,7 +68,7 @@ public:
 
   /**
    * Initialize a passive-mode BSD-style acceptor socket (no QoS).
-   * <local_sap> is the address that we're going to listen for
+   * @a local_sap is the address that we're going to listen for
    * connections on.  If @a reuse_addr is 1 then we'll use the
    * <SO_REUSEADDR> to reuse this address.  Returns 0 on success and
    * -1 on failure.
diff --git a/ACE/ace/SOCK_Dgram.h b/ACE/ace/SOCK_Dgram.h
index 21775fa4f80..7249f8cb8cb 100644
--- a/ACE/ace/SOCK_Dgram.h
+++ b/ACE/ace/SOCK_Dgram.h
@@ -130,7 +130,7 @@ public:
    * trying to receive.  If @a timeout == 0, the caller will block
    * until action is possible, else will wait until the relative time
    * specified in *@a timeout elapses).  If <recv> times out a -1 is
-   * returned with <errno == ETIME>.  If it succeeds the number of
+   * returned with @c errno == ETIME.  If it succeeds the number of
    * bytes received is returned.
    */
   ssize_t recv (void *buf,
@@ -145,7 +145,7 @@ public:
    * trying to receive.  If @a timeout == 0, the caller will block
    * until action is possible, else will wait until the relative time
    * specified in *@a timeout elapses).  If <send> times out a -1 is
-   * returned with <errno == ETIME>.  If it succeeds the number of
+   * returned with @c errno == ETIME.  If it succeeds the number of
    * bytes sent is returned.
    */
   ssize_t send (const void *buf,
diff --git a/ACE/ace/SOCK_IO.h b/ACE/ace/SOCK_IO.h
index d1187e45754..6ef390e114d 100644
--- a/ACE/ace/SOCK_IO.h
+++ b/ACE/ace/SOCK_IO.h
@@ -39,10 +39,10 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  * If @a timeout != 0, the call will wait until the relative time
  * specified in *@a timeout elapses.
  * Errors are reported by -1 and 0 return values.  If the
- * operation times out, -1 is returned with <errno == ETIME>.
+ * operation times out, -1 is returned with @c errno == ETIME.
  * If it succeeds the number of bytes transferred is returned.
- * Methods with the extra <flags> argument will always result in
- * <send> getting called. Methods without the extra <flags>
+ * Methods with the extra @a flags argument will always result in
+ * <send> getting called. Methods without the extra @a flags
  * argument will result in <send> getting called on Win32
  * platforms, and <write> getting called on non-Win32 platforms.
  */
diff --git a/ACE/ace/SOCK_SEQPACK_Acceptor.h b/ACE/ace/SOCK_SEQPACK_Acceptor.h
index e469df03341..d2bce596baf 100644
--- a/ACE/ace/SOCK_SEQPACK_Acceptor.h
+++ b/ACE/ace/SOCK_SEQPACK_Acceptor.h
@@ -51,7 +51,7 @@ public:
 
   /**
    * Initialize a passive-mode BSD-style acceptor socket (no QoS).
-   * <local_sap> is the address that we're going to listen for
+   * @a local_sap is the address that we're going to listen for
    * connections on.  If @a reuse_addr is 1 then we'll use the
    * <SO_REUSEADDR> to reuse this address.
    */
@@ -83,7 +83,7 @@ public:
 
   /**
    * Initialize a passive-mode BSD-style acceptor socket (no QoS).
-   * <local_sap> is the address that we're going to listen for
+   * @a local_sap is the address that we're going to listen for
    * connections on.  If @a reuse_addr is 1 then we'll use the
    * <SO_REUSEADDR> to reuse this address.  Returns 0 on success and
    * -1 on failure.
diff --git a/ACE/ace/SOCK_SEQPACK_Association.h b/ACE/ace/SOCK_SEQPACK_Association.h
index 0e61bcfb8df..beb211fa292 100644
--- a/ACE/ace/SOCK_SEQPACK_Association.h
+++ b/ACE/ace/SOCK_SEQPACK_Association.h
@@ -70,8 +70,8 @@ class ACE_Message_Block;
  * bytes transferred.
  * Methods with <iovec> parameter are I/O vector variants of the I/O
  * operations.
- * Methods with the extra <flags> argument will always result in
- * <send> getting called. Methods without the extra <flags> argument
+ * Methods with the extra @a flags argument will always result in
+ * <send> getting called. Methods without the extra @a flags argument
  * will result in <send> getting called on Win32 platforms, and
  * <write> getting called on non-Win32 platforms.
  */
diff --git a/ACE/ace/SPIPE_Connector.h b/ACE/ace/SPIPE_Connector.h
index eeaa3a70543..51e3476816b 100644
--- a/ACE/ace/SPIPE_Connector.h
+++ b/ACE/ace/SPIPE_Connector.h
@@ -40,20 +40,20 @@ public:
 
   /**
    * Actively connect and produce a <new_stream> if things go well.
-   * The <remote_sap> is the address that we are trying to connect
+   * The @a remote_sap is the address that we are trying to connect
    * with.  The @a timeout is the amount of time to wait to connect.
    * If it's 0 then we block indefinitely.  If *timeout == {0, 0} then
    * the connection is done using non-blocking mode.  In this case, if
    * the connection can't be made immediately the value of -1 is
-   * returned with <errno == EWOULDBLOCK>.  If *timeout > {0, 0} then
+   * returned with @c errno == EWOULDBLOCK.  If *timeout > {0, 0} then
    * this is the maximum amount of time to wait before timing out.  If the
-   * time expires before the connection is made <errno == ETIME>.  The
-   * <local_sap> is the value of local address to bind to.  If it's
-   * the default value of <ACE_Addr::sap_any> then the user is letting
+   * time expires before the connection is made @c errno == ETIME.  The
+   * @a local_sap is the value of local address to bind to.  If it's
+   * the default value of ACE_Addr::sap_any then the user is letting
    * the OS do the binding.  If @a reuse_addr == 1 then the
    * <local_addr> is reused, even if it hasn't been cleanedup yet.
-   * The <flags> and <perms> arguments are passed down to the <open>
-   * method.  The <pipe_mode> argument is only used in NT and is used to
+   * The @a flags and @a perms arguments are passed down to the <open>
+   * method.  The @a pipe_mode argument is only used in NT and is used to
    * establish the NT pipe mode.
    */
   ACE_SPIPE_Connector (ACE_SPIPE_Stream &new_io,
@@ -68,20 +68,20 @@ public:
 
   /**
    * Actively connect and produce a <new_stream> if things go well.
-   * The <remote_sap> is the address that we are trying to connect
+   * The @a remote_sap is the address that we are trying to connect
    * with.  The @a timeout is the amount of time to wait to connect.
    * If it's 0 then we block indefinitely.  If *timeout == {0, 0} then
    * the connection is done using non-blocking mode.  In this case, if
    * the connection can't be made immediately the value of -1 is
-   * returned with <errno == EWOULDBLOCK>.  If *timeout > {0, 0} then
+   * returned with @c errno == EWOULDBLOCK.  If *timeout > {0, 0} then
    * this is the maximum amount of time to wait before timing out.  If the
-   * time expires before the connection is made <errno == ETIME>.  The
-   * <local_sap> is the value of local address to bind to.  If it's
-   * the default value of <ACE_Addr::sap_any> then the user is letting
+   * time expires before the connection is made @c errno == ETIME.  The
+   * @a local_sap is the value of local address to bind to.  If it's
+   * the default value of ACE_Addr::sap_any then the user is letting
    * the OS do the binding.  If @a reuse_addr == 1 then the
    * <local_addr> is reused, even if it hasn't been cleanedup yet.
-   * The <flags> and <perms> arguments are passed down to the <open>
-   * method.  The <pipe_mode> argument is only used in NT and is used to
+   * The @a flags and @a perms arguments are passed down to the <open>
+   * method.  The @a pipe_mode argument is only used in NT and is used to
    * establish the NT pipe mode.
    */
   int connect (ACE_SPIPE_Stream &new_io,
diff --git a/ACE/ace/TLI_Connector.h b/ACE/ace/TLI_Connector.h
index 5caaff82d9f..971b9c82b92 100644
--- a/ACE/ace/TLI_Connector.h
+++ b/ACE/ace/TLI_Connector.h
@@ -41,16 +41,16 @@ public:
 
   /**
    * Actively connect and produce a <new_stream> if things go well.
-   * The <remote_sap> is the address that we are trying to connect
+   * The @a remote_sap is the address that we are trying to connect
    * with.  The @a timeout is the amount of time to wait to connect.
    * If it's 0 then we block indefinitely.  If *timeout == {0, 0} then
    * the connection is done using non-blocking mode.  In this case, if
    * the connection can't be made immediately the value of -1 is
-   * returned with <errno == EWOULDBLOCK>.  If *timeout > {0, 0} then
+   * returned with @c errno == EWOULDBLOCK.  If *timeout > {0, 0} then
    * this is the maximum amount of time to wait before timing out.  If the
-   * time expires before the connection is made <errno == ETIME>.  The
-   * <local_sap> is the value of local address to bind to.  If it's
-   * the default value of <ACE_Addr::sap_any> then the user is letting
+   * time expires before the connection is made @c errno == ETIME.  The
+   * @a local_sap is the value of local address to bind to.  If it's
+   * the default value of ACE_Addr::sap_any then the user is letting
    * the OS do the binding.  If @a reuse_addr == 1 then the
    * <local_addr> is reused, even if it hasn't been cleanedup yet.
    */
@@ -69,16 +69,16 @@ public:
 
   /**
    * Actively connect and produce a <new_stream> if things go well.
-   * The <remote_sap> is the address that we are trying to connect
+   * The @a remote_sap is the address that we are trying to connect
    * with.  The @a timeout is the amount of time to wait to connect.
    * If it's 0 then we block indefinitely.  If *timeout == {0, 0} then
    * the connection is done using non-blocking mode.  In this case, if
    * the connection can't be made immediately the value of -1 is
-   * returned with <errno == EWOULDBLOCK>.  If *timeout > {0, 0} then
+   * returned with @c errno == EWOULDBLOCK.  If *timeout > {0, 0} then
    * this is the maximum amount of time to wait before timing out.  If the
-   * time expires before the connection is made <errno == ETIME>.  The
-   * <local_sap> is the value of local address to bind to.  If it's
-   * the default value of <ACE_Addr::sap_any> then the user is letting
+   * time expires before the connection is made @c errno == ETIME.  The
+   * @a local_sap is the value of local address to bind to.  If it's
+   * the default value of ACE_Addr::sap_any then the user is letting
    * the OS do the binding.  If @a reuse_addr == 1 then the
    * <local_addr> is reused, even if it hasn't been cleanedup yet.
    */
@@ -98,7 +98,7 @@ public:
   /**
    * Try to complete a non-blocking connection.
    * If connection completion is successful then @a new_stream contains
-   * the connected ACE_SOCK_Stream.  If <remote_sap> is non-NULL then it
+   * the connected ACE_SOCK_Stream.  If @a remote_sap is non-NULL then it
    * will contain the address of the connected peer.
    */
   int complete (ACE_TLI_Stream &new_stream,
diff --git a/ACE/ace/Task.h b/ACE/ace/Task.h
index 90841555c92..b289f4e756f 100644
--- a/ACE/ace/Task.h
+++ b/ACE/ace/Task.h
@@ -119,8 +119,8 @@ public:
 
   // = Active object activation method.
   /**
-   * Turn the task into an active object, i.e., having <n_threads> of
-   * control, all running at the <priority> level (see below) with the
+   * Turn the task into an active object, i.e., having @a n_threads of
+   * control, all running at the @a priority level (see below) with the
    * same @a grp_id, all of which invoke <Task::svc>.  Returns -1 if
    * failure occurs, returns 1 if Task is already an active object and
    * @a force_active is false (i.e., do *not* create a new thread in
diff --git a/ACE/ace/Thread.h b/ACE/ace/Thread.h
index d6497a79496..f343a05484a 100644
--- a/ACE/ace/Thread.h
+++ b/ACE/ace/Thread.h
@@ -52,14 +52,14 @@ class ACE_Export ACE_Thread
 {
 public:
   /**
-   * Creates a new thread having <flags> attributes and running <func>
-   * with <args> (if <thread_adapter> is non-0 then <func> and <args>
+   * Creates a new thread having @a flags attributes and running @a func
+   * with <args> (if <thread_adapter> is non-0 then @a func and <args>
    * are ignored and are obtained from <thread_adapter>).  <thr_id>
    * and <t_handle> are set to the thread's ID and handle (?),
-   * respectively.  The thread runs at <priority> priority (see
+   * respectively.  The thread runs at @a priority priority (see
    * below).
    *
-   * The <flags> are a bitwise-OR of the following:
+   * The @a flags are a bitwise-OR of the following:
    * = BEGIN<INDENT>
    * THR_CANCEL_DISABLE, THR_CANCEL_ENABLE, THR_CANCEL_DEFERRED,
    * THR_CANCEL_ASYNCHRONOUS, THR_BOUND, THR_NEW_LWP, THR_DETACHED,
@@ -68,7 +68,7 @@ public:
    * THR_SCOPE_SYSTEM, THR_SCOPE_PROCESS
    * = END<INDENT>
    *
-   * By default, or if <priority> is set to
+   * By default, or if @a priority is set to
    * ACE_DEFAULT_THREAD_PRIORITY, an "appropriate" priority value for
    * the given scheduling policy (specified in <flags}>, e.g.,
    * <THR_SCHED_DEFAULT>) is used.  This value is calculated
@@ -115,8 +115,8 @@ public:
                          ACE_Thread_Adapter *thread_adapter = 0);
 
   /**
-   * Spawn @a n new threads, which execute <func> with argument <arg>
-   * (if <thread_adapter> is non-0 then <func> and <args> are ignored
+   * Spawn @a n new threads, which execute @a func with argument <arg>
+   * (if <thread_adapter> is non-0 then @a func and <args> are ignored
    * and are obtained from <thread_adapter>).  The thread_ids of
    * successfully spawned threads will be placed into the <thread_ids>
    * buffer (which must be the same size as @a n).  If @a stack != 0 it
diff --git a/ACE/ace/Thread_Hook.h b/ACE/ace/Thread_Hook.h
index 793c5b2c8db..e7638daa941 100644
--- a/ACE/ace/Thread_Hook.h
+++ b/ACE/ace/Thread_Hook.h
@@ -43,7 +43,7 @@ public:
   /**
    * This method can be overridden in a subclass to customize this
    * pre-function call "hook" invocation that can perform
-   * initialization processing before the thread entry point <func>
+   * initialization processing before the thread entry point @a func
    * method is called back.  The @a func and @a arg passed into the
    * start hook are the same as those passed by the application that
    * spawned the thread.
diff --git a/ACE/ace/UPIPE_Connector.h b/ACE/ace/UPIPE_Connector.h
index c2778f82a11..77bbf00550e 100644
--- a/ACE/ace/UPIPE_Connector.h
+++ b/ACE/ace/UPIPE_Connector.h
@@ -45,9 +45,9 @@ public:
    * If it's 0 then we block indefinitely.  If *timeout == {0, 0} then
    * the connection is done using non-blocking mode.  In this case, if
    * the connection can't be made immediately the value of -1 is
-   * returned with <errno == EWOULDBLOCK>.  If *timeout > {0, 0} then
+   * returned with @c errno == EWOULDBLOCK.  If *timeout > {0, 0} then
    * this is the maximum amount of time to wait before timing out.  If the
-   * time expires before the connection is made <errno == ETIME>.  The
+   * time expires before the connection is made @c errno == ETIME.  The
    * @a local_sap is the value of local address to bind to.  If it's
    * the default value of ACE_Addr::sap_any then the user is letting
    * the OS do the binding.  If @a reuse_addr == 1 then the
@@ -70,9 +70,9 @@ public:
    * If it's 0 then we block indefinitely.  If *timeout == {0, 0} then
    * the connection is done using non-blocking mode.  In this case, if
    * the connection can't be made immediately the value of -1 is
-   * returned with <errno == EWOULDBLOCK>.  If *timeout > {0, 0} then
+   * returned with @c errno == EWOULDBLOCK.  If *timeout > {0, 0} then
    * this is the maximum amount of time to wait before timing out.  If the
-   * time expires before the connection is made <errno == ETIME>.  The
+   * time expires before the connection is made @c errno == ETIME.  The
    * @a local_sap is the value of local address to bind to.  If it's
    * the default value of ACE_Addr::sap_any then the user is letting
    * the OS do the binding.  If @a reuse_addr == 1 then the
diff --git a/ACE/ace/UPIPE_Stream.h b/ACE/ace/UPIPE_Stream.h
index e43a1eb4330..87bcf82d1e2 100644
--- a/ACE/ace/UPIPE_Stream.h
+++ b/ACE/ace/UPIPE_Stream.h
@@ -118,8 +118,7 @@ private:
   /// @c UPIPE_Connector to link together two UPIPE_Streams.
   MT_Stream stream_;
 
-  /// Keep track of whether the sender and receiver have both shut
-  /// down.
+  /// Keep track of whether the sender and receiver have both shutdown.
   int reference_count_;
 
 #if defined (ACE_MT_SAFE) && (ACE_MT_SAFE != 0)
diff --git a/ACE/ace/XTI_ATM_Mcast.h b/ACE/ace/XTI_ATM_Mcast.h
index 3172e942e8a..360becbaa63 100644
--- a/ACE/ace/XTI_ATM_Mcast.h
+++ b/ACE/ace/XTI_ATM_Mcast.h
@@ -43,16 +43,16 @@ public:
 
   /**
    * Actively connect and produce a @a new_stream if things go well.
-   * The <remote_sap> is the address that we are trying to connect
+   * The @a remote_sap is the address that we are trying to connect
    * with.  The @a timeout is the amount of time to wait to connect.
    * If it's 0 then we block indefinitely.  If *timeout == {0, 0} then
    * the connection is done using non-blocking mode.  In this case, if
    * the connection can't be made immediately the value of -1 is
-   * returned with <errno == EWOULDBLOCK>.  If *timeout > {0, 0} then
+   * returned with @c errno == EWOULDBLOCK.  If *timeout > {0, 0} then
    * this is the amount of time to wait before timing out.  If the
-   * time expires before the connection is made <errno == ETIME>.  The
-   * <local_sap> is the value of local address to bind to.  If it's
-   * the default value of <ACE_Addr::sap_any> then the user is letting
+   * time expires before the connection is made @c errno == ETIME.  The
+   * @a local_sap is the value of local address to bind to.  If it's
+   * the default value of ACE_Addr::sap_any then the user is letting
    * the OS do the binding.  If @a reuse_addr == 1 then the
    * <local_addr> is reused, even if it hasn't been cleanedup yet.
    */
@@ -71,16 +71,16 @@ public:
 
   /**
    * Actively connect and produce a @a new_stream if things go well.
-   * The <remote_sap> is the address that we are trying to connect
+   * The @a remote_sap is the address that we are trying to connect
    * with.  The @a timeout is the amount of time to wait to connect.
    * If it's 0 then we block indefinitely.  If *timeout == {0, 0} then
    * the connection is done using non-blocking mode.  In this case, if
    * the connection can't be made immediately the value of -1 is
-   * returned with <errno == EWOULDBLOCK>.  If *timeout > {0, 0} then
+   * returned with @c errno == EWOULDBLOCK.  If *timeout > {0, 0} then
    * this is the amount of time to wait before timing out.  If the
-   * time expires before the connection is made <errno == ETIME>.  The
-   * <local_sap> is the value of local address to bind to.  If it's
-   * the default value of <ACE_Addr::sap_any> then the user is letting
+   * time expires before the connection is made @c errno == ETIME.  The
+   * @a local_sap is the value of local address to bind to.  If it's
+   * the default value of ACE_Addr::sap_any then the user is letting
    * the OS do the binding.  If @a reuse_addr == 1 then the
    * <local_addr> is reused, even if it hasn't been cleanedup yet.
    */
@@ -99,14 +99,14 @@ public:
 
   /**
    * Actively add a leaf to the currently connected stream (i.e.,
-   * multicast). The <remote_sap> is the address of the leaf that we
+   * multicast). The @a remote_sap is the address of the leaf that we
    * are trying to add. The @a timeout is the amount of time to wait to
    * connect. If it's 0 then we block indefinitely.  If *timeout ==
    * {0, 0} then the connection is done using non-blocking mode.  In
    * this case, if the connection can't be made immediately the value
-   * of -1 is returned with <errno == EWOULDBLOCK>.  If *timeout >
+   * of -1 is returned with @c errno == EWOULDBLOCK.  If *timeout >
    * {0, 0} then this is the amount of time to wait before timing out.
-   * If the time expires before the connection is made <errno == ETIME>.
+   * If the time expires before the connection is made @c errno == ETIME.
    */
   int add_leaf (ACE_TLI_Stream &current_stream,
                 const ACE_Addr &remote_sap,