diff options
40 files changed, 271 insertions, 228 deletions
diff --git a/ACE/ChangeLog b/ACE/ChangeLog index 5a678b3212d..d031d82b4fc 100644 --- a/ACE/ChangeLog +++ b/ACE/ChangeLog @@ -1,3 +1,46 @@ +Thu Feb 15 13:38:58 UTC 2007 Johnny Willemsen <jwillemsen@remedy.nl> + + * ace/ATM_Connector.h: + * ace/DEV_Connector.h: + * ace/DEV_IO.h: + * ace/Dev_Poll_Reactor.h: + * ace/FILE_Connector.h: + * ace/Hash_Map_Manager_T.h: + * ace/IOStream_T.h: + * ace/LOCK_SOCK_Acceptor.h: + * ace/Map_Manager.h: + * ace/MEM_IO.h: + * ace/MEM_SAP.h: + * ace/MEM_Stream.h: + * ace/Message_Block.h: + * ace/Message_Queue.h: + * ace/Message_Queue_T.h: + * ace/Module.h: + * ace/Proactor.h: + * ace/Reactor.h: + * ace/Reactor_Impl.h: + * ace/Select_Reactor_T.h: + * ace/Sig_Handler.h: + * ace/Signal.h: + * ace/SOCK.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/Stream.h: + * ace/Svc_Handler.h: + * ace/Task_Ex_T.h: + * ace/Task_T.h: + * ace/Thread_Manager.h: + * ace/TLI_Acceptor.h: + * ace/TLI_Connector.h: + * ace/Token.h: + * ace/WFMO_Reactor.h: + * ace/XTI_ATM_Mcast.h: + Doxygen improvements + Thu Feb 15 13:12:01 UTC 2007 Chad Elliott <elliott_c@ociweb.com> * examples/OS/Process/imore.cpp: diff --git a/ACE/ace/ATM_Connector.h b/ACE/ace/ATM_Connector.h index 3212eb20be3..db4ec2d0cd1 100644 --- a/ACE/ace/ATM_Connector.h +++ b/ACE/ace/ATM_Connector.h @@ -59,7 +59,7 @@ public: * Actively connect and produce a <new_stream> if things go well. * The <remote_sap> is the address that we are trying to connect * with. The <params> are the parameters needed for either socket - * or XTI/ATM connections. The <timeout> is the amount of time to + * or XTI/ATM connections. 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 @@ -89,7 +89,7 @@ public: * Actively connect and produce a <new_stream> if things go well. * The <remote_sap> is the address that we are trying to connect * with. The <params> are the parameters needed for either socket - * or XTI/ATM connections. The <timeout> is the amount of time to + * or XTI/ATM connections. 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 diff --git a/ACE/ace/DEV_Connector.h b/ACE/ace/DEV_Connector.h index 2d57f836b24..11e2216b9ce 100644 --- a/ACE/ace/DEV_Connector.h +++ b/ACE/ace/DEV_Connector.h @@ -39,7 +39,7 @@ public: /** * Actively connect and produce a <new_stream> if things go well. * The <remote_sap> is the address that we are trying to connect - * with. The <timeout> is the amount of time to wait 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 @@ -64,7 +64,7 @@ public: /** * Actively connect and produce a <new_stream> if things go well. * The <remote_sap> is the address that we are trying to connect - * with. The <timeout> is the amount of time to wait 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 diff --git a/ACE/ace/DEV_IO.h b/ACE/ace/DEV_IO.h index fd2a0e2c5b8..172e7db8f72 100644 --- a/ACE/ace/DEV_IO.h +++ b/ACE/ace/DEV_IO.h @@ -65,19 +65,19 @@ public: * * <len> is the number of bytes to transfer. * - * The <timeout> parameter in the following methods indicates how - * long to blocking trying to transfer data. If <timeout> == 0, + * The @a timeout parameter in the following methods indicates how + * long to blocking trying to transfer data. If @a timeout == 0, * then the call behaves as a normal send/recv call, i.e., for * blocking sockets, the call will block until action is possible; * for non-blocking sockets, EWOULDBLOCK will be returned if no * action is immediately possible. * - * If <timeout> != 0, the call will wait until the relative time - * specified in *<timeout> elapses. + * If @a timeout != 0, the call will wait until the relative time + * specified in *@a timeout elapses. * * The "_n()" I/O methods keep looping until all the data has been * transferred. These methods also work for sockets in non-blocking - * mode i.e., they keep looping on EWOULDBLOCK. <timeout> is used + * mode i.e., they keep looping on EWOULDBLOCK. @a timeout is used * to make sure we keep making progress, i.e., the same timeout * value is used for every I/O operation in the loop and the timeout * is not counted down. diff --git a/ACE/ace/Dev_Poll_Reactor.h b/ACE/ace/Dev_Poll_Reactor.h index 612525c7eec..f8c5b58f1d2 100644 --- a/ACE/ace/Dev_Poll_Reactor.h +++ b/ACE/ace/Dev_Poll_Reactor.h @@ -684,10 +684,10 @@ public: ACE_Reactor_Mask mask); /** - * Remove the ACE_Event_Handler currently associated with <signum>. + * Remove the ACE_Event_Handler currently associated with @a signum. * Install the new disposition (if given) and return the previous * disposition (if desired by the caller). Returns 0 on success and - * -1 if <signum> is invalid. + * -1 if @a signum is invalid. */ virtual int remove_handler (int signum, ACE_Sig_Action *new_disp, @@ -811,10 +811,10 @@ public: // = Notification methods. /** - * Notify <event_handler> of <mask> event. The <ACE_Time_Value> - * indicates how long to blocking trying to notify. If <timeout> == + * Notify <event_handler> of <mask> event. The ACE_Time_Value + * indicates how long to blocking trying to notify. If @a timeout == * 0, the caller will block until action is possible, else will wait - * until the relative time specified in <timeout> elapses). + * until the relative time specified in @a timeout elapses). */ virtual int notify (ACE_Event_Handler *event_handler = 0, ACE_Reactor_Mask mask = ACE_Event_Handler::EXCEPT_MASK, @@ -864,7 +864,7 @@ public: ACE_Event_Handler **event_handler = 0); /** - * Check to see if <signum> is associated with a valid Event_Handler + * Check to see if @a signum is associated with a valid Event_Handler * bound to a signal. Return the <event_handler> associated with * this <handler> if <event_handler> != 0. */ diff --git a/ACE/ace/FILE_Connector.h b/ACE/ace/FILE_Connector.h index 54352f1e066..3bf5e675d93 100644 --- a/ACE/ace/FILE_Connector.h +++ b/ACE/ace/FILE_Connector.h @@ -48,7 +48,7 @@ public: * if things go well. The <remote_sap> is the file that we are * trying to create/open. If it's the default value of * <ACE_Addr::sap_any> then the user is letting the OS create the - * filename (via <ACE_OS::mkstemp>). The <timeout> is the amount of + * filename (via <ACE_OS::mkstemp>). The @a timeout is the amount of * time to wait to create/open the file. If it's 0 then we block * indefinitely. If *timeout == {0, 0} then the file is created * using non-blocking mode. If *timeout > {0, 0} then this is the @@ -70,7 +70,7 @@ public: * if things go well. The <remote_sap> is the file that we are * trying to create/open. If it's the default value of * <ACE_Addr::sap_any> then the user is letting the OS create the - * filename (via <ACE_OS::mkstemp>). The <timeout> is the amount of + * filename (via <ACE_OS::mkstemp>). The @a timeout is the amount of * time to wait to create/open the file. If it's 0 then we block * indefinitely. If *timeout == {0, 0} then the file is created * using non-blocking mode. In this case, if the create/open can't diff --git a/ACE/ace/Hash_Map_Manager_T.h b/ACE/ace/Hash_Map_Manager_T.h index 252af6ec00a..ae9d41c2ae4 100644 --- a/ACE/ace/Hash_Map_Manager_T.h +++ b/ACE/ace/Hash_Map_Manager_T.h @@ -159,7 +159,7 @@ public: typedef value_type const * const_pointer; // typedef ptrdiff_t difference_type; typedef size_t size_type; - + // = Initialization and termination methods. /** @@ -219,7 +219,7 @@ public: ~ACE_Hash_Map_Manager_Ex (void); /** - * Associate <ext_id> with <int_id>. If <ext_id> is already in the + * Associate @a ext_id with @a int_id. If @a ext_id is already in the * map then the <ACE_Hash_Map_Entry> is not changed. Returns 0 if a * new entry is bound successfully, returns 1 if an attempt is made * to bind an existing entry, and returns -1 if failures occur. @@ -237,8 +237,8 @@ public: ACE_Hash_Map_Entry<EXT_ID, INT_ID> *&entry); /** - * Associate <ext_id> with <int_id> if and only if <ext_id> is not - * in the map. If <ext_id> is already in the map then the <int_id> + * Associate @a ext_id with @a int_id if and only if @a ext_id is not + * in the map. If @a ext_id is already in the map then the @a int_id * parameter is assigned the existing value in the map. Returns 0 * if a new entry is bound successfully, returns 1 if an attempt is * made to bind an existing entry, and returns -1 if failures occur. @@ -256,7 +256,7 @@ public: ACE_Hash_Map_Entry<EXT_ID, INT_ID> *&entry); /** - * Reassociate <ext_id> with <int_id>. If <ext_id> is not in the + * Reassociate @a ext_id with @a int_id. If @a ext_id is not in the * map then behaves just like <bind>. Returns 0 if a new entry is * bound successfully, returns 1 if an existing entry was rebound, * and returns -1 if failures occur. @@ -274,9 +274,9 @@ public: ACE_Hash_Map_Entry<EXT_ID, INT_ID> *&entry); /** - * Associate <ext_id> with <int_id>. If <ext_id> is not in the map + * Associate @a ext_id with @a int_id. If @a ext_id is not in the map * then behaves just like <bind>. Otherwise, store the old value of - * <int_id> into the "out" parameter and rebind the new parameters. + * @a int_id into the "out" parameter and rebind the new parameters. * Returns 0 if a new entry is bound successfully, returns 1 if an * existing entry was rebound, and returns -1 if failures occur. */ @@ -295,9 +295,9 @@ public: ACE_Hash_Map_Entry<EXT_ID, INT_ID> *&entry); /** - * Associate <ext_id> with <int_id>. If <ext_id> is not in the map + * Associate @a ext_id with @a int_id. If @a ext_id is not in the map * then behaves just like <bind>. Otherwise, store the old values - * of <ext_id> and <int_id> into the "out" parameters and rebind the + * of @a ext_id and @a int_id into the "out" parameters and rebind the * new parameters. This is very useful if you need to have an * atomic way of updating <ACE_Hash_Map_Entrys> and you also need * full control over memory allocation. Returns 0 if a new entry is @@ -320,20 +320,20 @@ public: INT_ID &old_int_id, ACE_Hash_Map_Entry<EXT_ID, INT_ID> *&entry); - /// Locate <ext_id> and pass out parameter via <int_id>. + /// Locate @a ext_id and pass out parameter via @a int_id. /// Return 0 if found, returns -1 if not found. int find (const EXT_ID &ext_id, INT_ID &int_id) const; - /// Returns 0 if the <ext_id> is in the mapping, otherwise -1. + /// Returns 0 if the @a ext_id is in the mapping, otherwise -1. int find (const EXT_ID &ext_id) const; - /// Locate <ext_id> and pass out parameter via <entry>. If found, + /// Locate @a ext_id and pass out parameter via <entry>. If found, /// return 0, returns -1 if not found. int find (const EXT_ID &ext_id, ACE_Hash_Map_Entry<EXT_ID, INT_ID> *&entry) const; - /// Locate <ext_id> and pass out an iterator that points to its + /// Locate @a ext_id and pass out an iterator that points to its /// corresponding value. /** * @param pos @a pos will be set to @c end() if not found. @@ -341,13 +341,13 @@ public: void find (EXT_ID const & ext_id, iterator & pos) const; /** - * Unbind (remove) the <ext_id> from the map. Don't return the - * <int_id> to the caller (this is useful for collections where the - * <int_id>s are *not* dynamically allocated...) + * Unbind (remove) the @a ext_id from the map. Don't return the + * @a int_id to the caller (this is useful for collections where the + * @a int_ids are *not* dynamically allocated...) */ int unbind (const EXT_ID &ext_id); - /// Break any association of <ext_id>. Returns the value of <int_id> + /// Break any association of @a ext_id. Returns the value of @a int_id /// in case the caller needs to deallocate memory. Return 0 if the /// unbind was successfully, and returns -1 if failures occur. int unbind (const EXT_ID &ext_id, @@ -372,7 +372,7 @@ public: * occur. */ int unbind (iterator pos); - + /// Returns the current number of ACE_Hash_Map_Entry objects in the /// hash table. size_t current_size (void) const; @@ -401,7 +401,7 @@ public: iterator end (void); const_iterator begin (void) const; const_iterator end (void) const; - + /// Return reverse iterator. reverse_iterator rbegin (void); reverse_iterator rend (void); @@ -415,7 +415,7 @@ protected: /// separate method to facilitate template specialization. int equal (const EXT_ID &id1, const EXT_ID &id2); - /// Compute the hash value of the <ext_id>. This is defined as a + /// Compute the hash value of the @a ext_id. This is defined as a /// separate method to facilitate template specialization. u_long hash (const EXT_ID &ext_id); @@ -472,16 +472,16 @@ protected: INT_ID &old_int_id, ACE_Hash_Map_Entry<EXT_ID, INT_ID> *&entry); - /// Performs a find of <int_id> using <ext_id> as the key. Must be + /// Performs a find of @a int_id using @a ext_id as the key. Must be /// called with locks held. int find_i (const EXT_ID &ext_id, INT_ID &int_id); - /// Performs a find using <ext_id> as the key. Must be called with + /// Performs a find using @a ext_id as the key. Must be called with /// locks held. int find_i (const EXT_ID &ext_id); - /// Performs a find using <ext_id> as the key. Must be called with + /// Performs a find using @a ext_id as the key. Must be called with /// locks held. int find_i (const EXT_ID &ext_id, ACE_Hash_Map_Entry<EXT_ID, INT_ID> *&entry); @@ -531,7 +531,7 @@ protected: COMPARE_KEYS compare_keys_; protected: - /// Returns the <ACE_Hash_Map_Entry> that corresponds to <ext_id>. + /// Returns the <ACE_Hash_Map_Entry> that corresponds to @a ext_id. int shared_find (const EXT_ID &ext_id, ACE_Hash_Map_Entry<EXT_ID, INT_ID> *&entry, size_t &loc); diff --git a/ACE/ace/IOStream_T.h b/ACE/ace/IOStream_T.h index 4460ef4be9e..0992bdc131d 100644 --- a/ACE/ace/IOStream_T.h +++ b/ACE/ace/IOStream_T.h @@ -133,7 +133,7 @@ public: /** * Returns 1 if we're at the end of the <STREAM>, i.e., if the * connection has closed down or an error has occurred, else 0. - * Under the covers, <eof> calls the streambuf's <timeout> function + * Under the covers, <eof> calls the streambuf's @a timeout function * which will reset the timeout flag. As as result, you should save * the return of <eof> and check it instead of calling <eof> * successively. diff --git a/ACE/ace/LOCK_SOCK_Acceptor.h b/ACE/ace/LOCK_SOCK_Acceptor.h index ae7775d3039..cfca422e8d7 100644 --- a/ACE/ace/LOCK_SOCK_Acceptor.h +++ b/ACE/ace/LOCK_SOCK_Acceptor.h @@ -26,7 +26,7 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL /** * @class ACE_LOCK_SOCK_Acceptor * - * @brief Specialize <ACE_SOCK_Acceptor> to lock around <accept>; + * @brief Specialize ACE_SOCK_Acceptor to lock around <accept>; * * This class is necessary since some OS platforms (e.g., * Solaris 2.5) do not allow multiple threads/processes to diff --git a/ACE/ace/MEM_IO.h b/ACE/ace/MEM_IO.h index f294de2a94d..1b49fa8a094 100644 --- a/ACE/ace/MEM_IO.h +++ b/ACE/ace/MEM_IO.h @@ -59,7 +59,7 @@ public: const ACE_Time_Value *timeout); /** - * Wait to to <timeout> amount of time to send <buf>. If <send> + * Wait to to @a timeout amount of time to send <buf>. If <send> * times out a -1 is returned with <errno == ETIME>. If it succeeds * the number of bytes sent is returned. */ virtual ssize_t send_buf (ACE_MEM_SAP_Node *buf, @@ -121,14 +121,14 @@ public: /** * Fetch location of next available data into <recv_buffer_>. * As this operation read the address of the data off the socket - * using ACE::recv, <timeout> only applies to ACE::recv. + * using ACE::recv, @a timeout only applies to ACE::recv. */ virtual ssize_t recv_buf (ACE_MEM_SAP_Node *&buf, int flags, const ACE_Time_Value *timeout); /** - * Wait to to <timeout> amount of time to send <buf>. If <send> + * Wait to to @a timeout amount of time to send <buf>. If <send> * times out a -1 is returned with <errno == ETIME>. If it succeeds * the number of bytes sent is returned. */ virtual ssize_t send_buf (ACE_MEM_SAP_Node *buf, @@ -217,7 +217,7 @@ public: size_t n) ; /** - * Wait to to <timeout> amount of time to send up to <n> bytes into + * Wait to to @a timeout amount of time to send up to <n> bytes into * <buf> from <handle> (uses the <send> call). If <send> times out * a -1 is returned with <errno == ETIME>. If it succeeds the * number of bytes sent is returned. @@ -227,7 +227,7 @@ public: const ACE_Time_Value *timeout); /** - * Wait to to <timeout> amount of time to send up to <n> bytes into + * Wait to to @a timeout amount of time to send up to <n> bytes into * <buf> from <handle> (uses the <send> call). If <send> times out * a -1 is returned with <errno == ETIME>. If it succeeds the * number of bytes sent is returned. @@ -238,7 +238,7 @@ public: const ACE_Time_Value *timeout); /** - * Wait to to <timeout> amount of time to send the <message_block>. + * Wait to to @a timeout amount of time to send the <message_block>. * If <send> times out a -1 is returned with <errno == ETIME>. If * it succeeds the number of bytes sent is returned. */ @@ -246,7 +246,7 @@ public: const ACE_Time_Value *timeout); /** - * Wait up to <timeout> amount of time to receive up to <n> bytes + * Wait up to @a timeout amount of time to receive up to <n> bytes * into <buf> from <handle> (uses the <recv> call). If <recv> times * out a -1 is returned with <errno == ETIME>. If it succeeds the * number of bytes received is returned. @@ -256,7 +256,7 @@ public: const ACE_Time_Value *timeout); /** - * Wait up to <timeout> amount of time to receive up to <n> bytes + * Wait up to @a timeout amount of time to receive up to <n> bytes * into <buf> from <handle> (uses the <recv> call). If <recv> times * out a -1 is returned with <errno == ETIME>. If it succeeds the * number of bytes received is returned. diff --git a/ACE/ace/MEM_SAP.h b/ACE/ace/MEM_SAP.h index a6c8dcb718f..01da250e38c 100644 --- a/ACE/ace/MEM_SAP.h +++ b/ACE/ace/MEM_SAP.h @@ -110,7 +110,7 @@ public: const ACE_Time_Value *timeout) = 0; /** - * Wait to to <timeout> amount of time to send <buf>. If <send> + * Wait to to @a timeout amount of time to send <buf>. If <send> * times out a -1 is returned with <errno == ETIME>. If it succeeds * the number of bytes sent is returned. */ virtual ssize_t send_buf (ACE_MEM_SAP_Node *buf, diff --git a/ACE/ace/MEM_Stream.h b/ACE/ace/MEM_Stream.h index 6b4ff4cdd41..95a86b3ddf2 100644 --- a/ACE/ace/MEM_Stream.h +++ b/ACE/ace/MEM_Stream.h @@ -82,7 +82,7 @@ public: #if 0 /** * Try to send exactly <len> bytes into <buf> from <handle> (uses - * the <send> call). If <send> blocks for longer than <timeout> the + * the <send> call). If <send> blocks for longer than @a timeout the * number of bytes actually sent is returned with <errno == ETIME>. * If a timeout does not occur, <send_n> return <len> (i.e., the * number of bytes requested to be sent). @@ -94,11 +94,11 @@ public: /** * Try to recv exactly <len> bytes into <buf> from <handle> (uses - * the <ACE::recv_n> call). The <ACE_Time_Value> indicates how long - * to blocking trying to receive. If <timeout> == 0, the caller + * the <ACE::recv_n> call). The ACE_Time_Value indicates how long + * to blocking trying to receive. If @a timeout == 0, the caller * will block until action is possible, else will wait until the - * relative time specified in *<timeout> elapses). If <recv> blocks - * for longer than <timeout> the number of bytes actually read is + * relative time specified in *@a timeout elapses). If <recv> blocks + * for longer than @a timeout the number of bytes actually read is * returned with <errno == ETIME>. If a timeout does not occur, * <recv_n> return <len> (i.e., the number of bytes requested to be * read). diff --git a/ACE/ace/Map_Manager.h b/ACE/ace/Map_Manager.h index 2c3f800c6bc..0e34d6b30c7 100644 --- a/ACE/ace/Map_Manager.h +++ b/ACE/ace/Map_Manager.h @@ -180,7 +180,7 @@ public: /** * Reassociate @a ext_id with @a int_id. If @a ext_id is not in the * map then behaves just like bind(). Otherwise, store the old - * values of <ext_id> and <int_id> into the "out" parameters and + * values of @a ext_id and @a int_id into the "out" parameters and * rebind the new parameters. This is very useful if you need to * have an atomic way of updating <Map_Entries> and you also need * full control over memory allocation. @@ -194,9 +194,9 @@ public: INT_ID &old_int_id); /** - * Reassociate @a ext_id with @a int_id. If <ext_id> is not in the + * Reassociate @a ext_id with @a int_id. If @a ext_id is not in the * map then behaves just like <bind>. Otherwise, store the old - * values of <int_id> into the "out" parameter and rebind the new + * values of @a int_id into the "out" parameter and rebind the new * parameters. * @retval 0 If a new entry is bound successfully. * @retval 1 If an existing entry was rebound. @@ -212,8 +212,8 @@ public: const INT_ID &int_id); /** - * Associate <ext_id> with <int_id> if and only if <ext_id> is not - * in the map. If <ext_id> is already in the map then the <int_id> + * Associate @a ext_id with @a int_id if and only if @a ext_id is not + * in the map. If @a ext_id is already in the map then the @a int_id * parameter is overwritten with the existing value in the map * @retval 0 If a new entry is bound successfully. * @retval 1 If an attempt is made to bind an existing entry. @@ -223,26 +223,26 @@ public: INT_ID &int_id); /** - * Locate <ext_id> and pass out parameter via <int_id>. + * Locate @a ext_id and pass out parameter via @a int_id. * @retval 0 If found. * @retval -1 If not found. */ int find (const EXT_ID &ext_id, INT_ID &int_id) const; - /// Returns 0 if the <ext_id> is in the mapping, otherwise -1. + /// Returns 0 if the @a ext_id is in the mapping, otherwise -1. int find (const EXT_ID &ext_id) const; /** - * Unbind (remove) the <ext_id> from the map. Don't return the - * <int_id> to the caller (this is useful for collections where the - * <int_id>s are *not* dynamically allocated...) Returns 0 if + * Unbind (remove) the @a ext_id from the map. Don't return the + * @a int_id to the caller (this is useful for collections where the + * @a int_ids are *not* dynamically allocated...) Returns 0 if * successful, else -1. */ int unbind (const EXT_ID &ext_id); /** - * Break any association of <ext_id>. Returns the value of <int_id> + * Break any association of @a ext_id. Returns the value of @a int_id * in case the caller needs to deallocate memory. Returns 0 if * successful, else -1. */ @@ -293,7 +293,7 @@ protected: // These methods assume that the locks are held by the private // methods. - /// Performs the binding of <ext_id> to <int_id>. Must be called + /// Performs the binding of @a ext_id to @a int_id. Must be called /// with locks held. int bind_i (const EXT_ID &ext_id, const INT_ID &int_id); @@ -303,49 +303,49 @@ protected: int shared_bind (const EXT_ID &ext_id, const INT_ID &int_id); - /// Performs a rebinding of <ext_it> to <int_id>. Also, recovers old + /// Performs a rebinding of <ext_it> to @a int_id. Also, recovers old /// values. Must be called with locks held. int rebind_i (const EXT_ID &ext_id, const INT_ID &int_id, EXT_ID &old_ext_id, INT_ID &old_int_id); - /// Performs a rebinding of <ext_it> to <int_id>. Also, recovers old + /// Performs a rebinding of <ext_it> to @a int_id. Also, recovers old /// values. Must be called with locks held. int rebind_i (const EXT_ID &ext_id, const INT_ID &int_id, INT_ID &old_int_id); - /// Performs a rebinding of <ext_it> to <int_id>. Must be called + /// Performs a rebinding of <ext_it> to @a int_id. Must be called /// with locks held. int rebind_i (const EXT_ID &ext_id, const INT_ID &int_id); - /// Performs a conditional bind of <int_id> using <ext_id> as the + /// Performs a conditional bind of @a int_id using @a ext_id as the /// key. Must be called with locks held. int trybind_i (const EXT_ID &ext_id, INT_ID &int_id); - /// Performs a find of <int_id> using <ext_id> as the key. Must be + /// Performs a find of @a int_id using @a ext_id as the key. Must be /// called with locks held. int find_i (const EXT_ID &ext_id, INT_ID &int_id); - /// Performs a find using <ext_id> as the key. Must be called with + /// Performs a find using @a ext_id as the key. Must be called with /// locks held. int find_and_return_index (const EXT_ID &ext_id, ACE_UINT32 &slot); - /// Performs an unbind of <int_id> using <ext_id> as the key. Must + /// Performs an unbind of @a int_id using @a ext_id as the key. Must /// be called with locks held. int unbind_i (const EXT_ID &ext_id, INT_ID &int_id); - /// Performs an unbind using <ext_id> as the key. Must be called + /// Performs an unbind using @a ext_id as the key. Must be called /// with locks held. int unbind_i (const EXT_ID &ext_id); - /// Performs an unbind using <ext_id> as the key. Must be called + /// Performs an unbind using @a ext_id as the key. Must be called /// with locks held. int unbind_and_return_index (const EXT_ID &ext_id, ACE_UINT32 &slot); diff --git a/ACE/ace/Message_Block.h b/ACE/ace/Message_Block.h index 4b0a73846e5..1f5c9d1971e 100644 --- a/ACE/ace/Message_Block.h +++ b/ACE/ace/Message_Block.h @@ -195,7 +195,7 @@ public: * the heap and does a copy of the data from the incoming message * block. As a final note, the alignment information is used to * align the data block if it is created afresh. If the incoming - * <mb> has a data block has a data block allocated from the heap, + * @a mb has a data block has a data block allocated from the heap, * then this constructor just duplicates (ie. a shallow copy) the * data block of the incoming @a mb. */ @@ -320,7 +320,7 @@ public: /** * Return a "shallow" copy that increments our reference count by 1. * This is similar to CORBA's <_duplicate> method, which is useful - * if you want to eliminate lots of checks for NULL <mb> pointers + * if you want to eliminate lots of checks for NULL @a mb pointers * before calling <_duplicate> on them. */ static ACE_Message_Block *duplicate (const ACE_Message_Block *mb); @@ -356,9 +356,9 @@ public: /** * This behaves like the non-static method <release>, except that it - * checks if <mb> is 0. This is similar to <CORBA::release>, which + * checks if @a mb is 0. This is similar to <CORBA::release>, which * is useful if you want to eliminate lots of checks for NULL - * pointers before calling <release> on them. Returns <mb>. + * pointers before calling <release> on them. Returns @a mb. */ static ACE_Message_Block *release (ACE_Message_Block *mb); @@ -756,7 +756,7 @@ public: /** * Decrease the shared reference count by 1. If the reference count * is > 0 then return this; else if reference count == 0 then delete - * <this> and <mb> and return 0. Behavior is undefined if reference + * <this> and @a mb and return 0. Behavior is undefined if reference * count < 0. */ ACE_Data_Block *release (ACE_Lock *lock = 0); diff --git a/ACE/ace/Message_Queue.h b/ACE/ace/Message_Queue.h index 6e92639459f..3e1713ac712 100644 --- a/ACE/ace/Message_Queue.h +++ b/ACE/ace/Message_Queue.h @@ -38,9 +38,9 @@ template <ACE_SYNCH_DECL> class ACE_Message_Queue_Reverse_Iterator; * @brief Base class for ACE_Message_Queue, which is the central * queueing facility for messages in the ACE framework. * - * For all the <ACE_Time_Value> pointer parameters the caller will - * block until action is possible if <timeout> == 0. Otherwise, it - * will wait until the absolute time specified in *<timeout> + * For all the ACE_Time_Value pointer parameters the caller will + * block until action is possible if @a timeout == 0. Otherwise, it + * will wait until the absolute time specified in *@a timeout * elapses. * * A queue is always in one of three states: @@ -94,8 +94,8 @@ public: /** * Retrieve the first ACE_Message_Block without removing it. Note - * that <timeout> uses <{absolute}> time rather than <{relative}> - * time. If the <timeout> elapses without receiving a message -1 is + * that @a timeout uses <{absolute}> time rather than <{relative}> + * time. If the @a timeout elapses without receiving a message -1 is * returned and <errno> is set to <EWOULDBLOCK>. If the queue is * deactivated -1 is returned and <errno> is set to <ESHUTDOWN>. * Otherwise, returns -1 on failure, else the number of items still diff --git a/ACE/ace/Message_Queue_T.h b/ACE/ace/Message_Queue_T.h index b1695c84248..d7973ed4dd7 100644 --- a/ACE/ace/Message_Queue_T.h +++ b/ACE/ace/Message_Queue_T.h @@ -1037,17 +1037,17 @@ public: // = Enqueue and dequeue methods. - // For the following enqueue and dequeue methods if <timeout> == 0, + // For the following enqueue and dequeue methods if @a timeout == 0, // the caller will block until action is possible, else will wait - // until the absolute time specified in *<timeout> elapses). These + // until the absolute time specified in *@a timeout elapses). These // calls will return, however, when queue is closed, deactivated, // when a signal occurs, or if the time specified in timeout // elapses, (in which case errno = EWOULDBLOCK). /** * Retrieve the first <ACE_MESSAGE_TYPE> without removing it. Note - * that <timeout> uses <{absolute}> time rather than <{relative}> - * time. If the <timeout> elapses without receiving a message -1 is + * that @a timeout uses <{absolute}> time rather than <{relative}> + * time. If the @a timeout elapses without receiving a message -1 is * returned and <errno> is set to <EWOULDBLOCK>. If the queue is * deactivated -1 is returned and <errno> is set to <ESHUTDOWN>. * Otherwise, returns -1 on failure, else the number of items still @@ -1060,8 +1060,8 @@ public: * Enqueue an <ACE_MESSAGE_TYPE *> into the <Message_Queue> in * accordance with its <msg_priority> (0 is lowest priority). FIFO * order is maintained when messages of the same priority are - * inserted consecutively. Note that <timeout> uses <{absolute}> - * time rather than <{relative}> time. If the <timeout> elapses + * inserted consecutively. Note that @a timeout uses <{absolute}> + * time rather than <{relative}> time. If the @a timeout elapses * without receiving a message -1 is returned and <errno> is set to * <EWOULDBLOCK>. If the queue is deactivated -1 is returned and * <errno> is set to <ESHUTDOWN>. Otherwise, returns -1 on failure, @@ -1074,8 +1074,8 @@ public: * Enqueue an <ACE_MESSAGE_TYPE *> into the <Message_Queue> in * accordance with its <msg_deadline_time>. FIFO * order is maintained when messages of the same deadline time are - * inserted consecutively. Note that <timeout> uses <{absolute}> - * time rather than <{relative}> time. If the <timeout> elapses + * inserted consecutively. Note that @a timeout uses <{absolute}> + * time rather than <{relative}> time. If the @a timeout elapses * without receiving a message -1 is returned and <errno> is set to * <EWOULDBLOCK>. If the queue is deactivated -1 is returned and * <errno> is set to <ESHUTDOWN>. Otherwise, returns -1 on failure, @@ -1087,7 +1087,7 @@ public: /** * This is an alias for <enqueue_prio>. It's only here for * backwards compatibility and will go away in a subsequent release. - * Please use <enqueue_prio> instead. Note that <timeout> uses + * Please use <enqueue_prio> instead. Note that @a timeout uses * <{absolute}> time rather than <{relative}> time. */ virtual int enqueue (ACE_MESSAGE_TYPE *new_item, @@ -1095,8 +1095,8 @@ public: /** * Enqueue an <ACE_MESSAGE_TYPE *> at the end of the queue. Note - * that <timeout> uses <{absolute}> time rather than <{relative}> - * time. If the <timeout> elapses without receiving a message -1 is + * that @a timeout uses <{absolute}> time rather than <{relative}> + * time. If the @a timeout elapses without receiving a message -1 is * returned and <errno> is set to <EWOULDBLOCK>. If the queue is * deactivated -1 is returned and <errno> is set to <ESHUTDOWN>. * Otherwise, returns -1 on failure, else the number of items still @@ -1107,8 +1107,8 @@ public: /** * Enqueue an <ACE_MESSAGE_TYPE *> at the head of the queue. Note - * that <timeout> uses <{absolute}> time rather than <{relative}> - * time. If the <timeout> elapses without receiving a message -1 is + * that @a timeout uses <{absolute}> time rather than <{relative}> + * time. If the @a timeout elapses without receiving a message -1 is * returned and <errno> is set to <EWOULDBLOCK>. If the queue is * deactivated -1 is returned and <errno> is set to <ESHUTDOWN>. * Otherwise, returns -1 on failure, else the number of items still @@ -1124,8 +1124,8 @@ public: /** * Dequeue and return the <ACE_MESSAGE_TYPE *> at the head of the - * queue. Note that <timeout> uses <{absolute}> time rather than - * <{relative}> time. If the <timeout> elapses without receiving a + * queue. Note that @a timeout uses <{absolute}> time rather than + * <{relative}> time. If the @a timeout elapses without receiving a * message -1 is returned and <errno> is set to <EWOULDBLOCK>. If * the queue is deactivated -1 is returned and <errno> is set to * <ESHUTDOWN>. Otherwise, returns -1 on failure, else the number @@ -1136,8 +1136,8 @@ public: /** * Dequeue and return the <ACE_MESSAGE_TYPE *> that has the lowest - * priority. Note that <timeout> uses <{absolute}> time rather than - * <{relative}> time. If the <timeout> elapses without receiving a + * priority. Note that @a timeout uses <{absolute}> time rather than + * <{relative}> time. If the @a timeout elapses without receiving a * message -1 is returned and <errno> is set to <EWOULDBLOCK>. If * the queue is deactivated -1 is returned and <errno> is set to * <ESHUTDOWN>. Otherwise, returns -1 on failure, else the number @@ -1148,8 +1148,8 @@ public: /** * Dequeue and return the <ACE_MESSAGE_TYPE *> at the tail of the - * queue. Note that <timeout> uses <{absolute}> time rather than - * <{relative}> time. If the <timeout> elapses without receiving a + * queue. Note that @a timeout uses <{absolute}> time rather than + * <{relative}> time. If the @a timeout elapses without receiving a * message -1 is returned and <errno> is set to <EWOULDBLOCK>. If * the queue is deactivated -1 is returned and <errno> is set to * <ESHUTDOWN>. Otherwise, returns -1 on failure, else the number @@ -1160,8 +1160,8 @@ public: /** * Dequeue and return the <ACE_MESSAGE_TYPE *> with the lowest - * deadline time. Note that <timeout> uses <{absolute}> time rather than - * <{relative}> time. If the <timeout> elapses without receiving a + * deadline time. Note that @a timeout uses <{absolute}> time rather than + * <{relative}> time. If the @a timeout elapses without receiving a * message -1 is returned and <errno> is set to <EWOULDBLOCK>. If * the queue is deactivated -1 is returned and <errno> is set to * <ESHUTDOWN>. Otherwise, returns -1 on failure, else the number @@ -1308,7 +1308,7 @@ protected: * version of the ACE_Message_Queue. If @c ACE_SYNCH_DECL is @c ACE_MT_SYNCH * then all operations are thread-safe. Otherwise, if it's @c ACE_NULL_SYNCH * then there's no locking overhead. - * + * * The @c ACE_MESSAGE_TYPE messages that are sent to this * queue can be chained. Messages are expected to have a * @c next method that returns the next message in the chain; diff --git a/ACE/ace/Module.h b/ACE/ace/Module.h index aa84e24683a..658f0bffc74 100644 --- a/ACE/ace/Module.h +++ b/ACE/ace/Module.h @@ -72,7 +72,7 @@ public: * which contains a pair of Tasks, one for handling upstream * processing, one for handling downstream processing. In * general, you shouldn't subclass from this class, but instead - * subclass from the <ACE_Task>. + * subclass from the ACE_Task. */ template <ACE_SYNCH_DECL> class ACE_Module : public ACE_Module_Base diff --git a/ACE/ace/Proactor.h b/ACE/ace/Proactor.h index bcea10ec0fa..88dd9321c4a 100644 --- a/ACE/ace/Proactor.h +++ b/ACE/ace/Proactor.h @@ -221,7 +221,7 @@ public: /** * Run the event loop until the <ACE_Proactor::handle_events> method * returns -1, the <end_event_loop> method is invoked, or the - * <ACE_Time_Value> expires, in which case 0 is returned. + * ACE_Time_Value expires, in which case 0 is returned. */ static int run_event_loop (ACE_Time_Value &tv); @@ -277,7 +277,7 @@ public: * Run the event loop until the <ACE_Proactor::handle_events> * method returns -1, the * <end_proactor_event_loop> method is invoked, - * or the <ACE_Time_Value> + * or the ACE_Time_Value * expires, in which case a 0 is returned. */ int proactor_run_event_loop (ACE_Time_Value &tv, diff --git a/ACE/ace/Reactor.h b/ACE/ace/Reactor.h index 195a9437ae9..492226465af 100644 --- a/ACE/ace/Reactor.h +++ b/ACE/ace/Reactor.h @@ -122,7 +122,7 @@ public: /** * Run the event loop until the <ACE_Reactor::handle_events> or * <ACE_Reactor::alertable_handle_events> methods returns -1, the - * <end_event_loop> method is invoked, or the <ACE_Time_Value> + * <end_event_loop> method is invoked, or the ACE_Time_Value * expires. Note that this method can only be used by the singleton * <ACE_Reactor::instance>. Thus, to run another reactor use * <ACE_Reactor::run_reactor_event_loop>. @@ -186,7 +186,7 @@ public: /** * Run the event loop until the <ACE_Reactor::handle_events> or * <ACE_Reactor::alertable_handle_events> methods returns -1, the - * <end_reactor_event_loop> method is invoked, or the <ACE_Time_Value> + * <end_reactor_event_loop> method is invoked, or the ACE_Time_Value * expires. */ virtual int run_reactor_event_loop (ACE_Time_Value &tv, diff --git a/ACE/ace/Reactor_Impl.h b/ACE/ace/Reactor_Impl.h index 68fa8b2c501..94d022b1dbf 100644 --- a/ACE/ace/Reactor_Impl.h +++ b/ACE/ace/Reactor_Impl.h @@ -58,10 +58,10 @@ public: * This wakeups the <Reactor_Impl> if currently blocked. Pass over * both the <Event_Handler> *and* the <mask> to allow the caller to * dictate which <Event_Handler> method the <Reactor_Impl> will - * invoke. The <ACE_Time_Value> indicates how long to blocking - * trying to notify the <Reactor_Impl>. If <timeout> == 0, the + * invoke. The ACE_Time_Value indicates how long to blocking + * trying to notify the <Reactor_Impl>. If @a timeout == 0, the * caller will block until action is possible, else will wait until - * the relative time specified in *<timeout> elapses). + * the relative time specified in *@a timeout elapses). */ virtual int notify (ACE_Event_Handler *eh = 0, ACE_Reactor_Mask mask = ACE_Event_Handler::EXCEPT_MASK, @@ -269,7 +269,7 @@ public: ACE_Reactor_Mask mask) = 0; /** - * Register <new_sh> to handle the signal <signum> using the + * Register <new_sh> to handle the signal @a signum using the * <new_disp>. Returns the <old_sh> that was previously registered * (if any), along with the <old_disp> of the signal handler. */ @@ -311,10 +311,10 @@ public: ACE_Reactor_Mask mask) = 0; /** - * Remove the ACE_Event_Handler currently associated with <signum>. + * Remove the ACE_Event_Handler currently associated with @a signum. * Install the new disposition (if given) and return the previous * disposition (if desired by the caller). Returns 0 on success and - * -1 if <signum> is invalid. + * -1 if @a signum is invalid. */ virtual int remove_handler (int signum, ACE_Sig_Action *new_disp, @@ -438,10 +438,10 @@ public: // = Notification methods. /** - * Notify <event_handler> of <mask> event. The <ACE_Time_Value> - * indicates how long to blocking trying to notify. If <timeout> == + * Notify <event_handler> of <mask> event. The ACE_Time_Value + * indicates how long to blocking trying to notify. If @a timeout == * 0, the caller will block until action is possible, else will wait - * until the relative time specified in <timeout> elapses). + * until the relative time specified in @a timeout elapses). */ virtual int notify (ACE_Event_Handler *event_handler = 0, ACE_Reactor_Mask mask = ACE_Event_Handler::EXCEPT_MASK, @@ -491,7 +491,7 @@ public: ACE_Event_Handler **event_handler = 0) = 0; /** - * Check to see if <signum> is associated with a valid Event_Handler + * Check to see if @a signum is associated with a valid Event_Handler * bound to a signal. Return the <event_handler> associated with * this <handler> if <event_handler> != 0. */ diff --git a/ACE/ace/SOCK.h b/ACE/ace/SOCK.h index 8690ac7c08e..4d97aef26a3 100644 --- a/ACE/ace/SOCK.h +++ b/ACE/ace/SOCK.h @@ -30,7 +30,7 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL * @class ACE_SOCK * * @brief An abstract class that forms the basis for more specific - * classes, such as <ACE_SOCK_Acceptor> and <ACE_SOCK_Stream>. + * classes, such as ACE_SOCK_Acceptor and <ACE_SOCK_Stream>. * Do not instantiate this class. * * This class provides functions that are common to all of the diff --git a/ACE/ace/SOCK_Acceptor.h b/ACE/ace/SOCK_Acceptor.h index 4341698c7c9..35e112c1aa3 100644 --- a/ACE/ace/SOCK_Acceptor.h +++ b/ACE/ace/SOCK_Acceptor.h @@ -98,11 +98,11 @@ public: // = Passive connection <accept> methods. /** - * Accept a new <ACE_SOCK_Stream> connection. A <timeout> of 0 - * means block forever, a <timeout> of {0, 0} means poll. <restart> + * Accept a new <ACE_SOCK_Stream> connection. A @a timeout of 0 + * means block forever, a @a timeout of {0, 0} means poll. <restart> * == 1 means "restart if interrupted," i.e., if errno == EINTR. * Note that <new_stream> inherits the "blocking mode" of <this> - * <ACE_SOCK_Acceptor>, i.e., if <this> acceptor factory is in + * ACE_SOCK_Acceptor, i.e., if <this> acceptor factory is in * non-blocking mode, the <net_stream> will be in non-blocking mode * and vice versa. */ @@ -115,11 +115,11 @@ public: #if !defined (ACE_HAS_WINCE) /** * Accept a new <ACE_SOCK_Stream> connection using the QoS - * information in <qos_params>. A <timeout> of 0 means block - * forever, a <timeout> of {0, 0} means poll. <restart> == 1 means + * information in <qos_params>. A @a timeout of 0 means block + * forever, a @a timeout of {0, 0} means poll. <restart> == 1 means * "restart if interrupted," i.e., if errno == EINTR. Note that * <new_stream> inherits the "blocking mode" of <this> - * <ACE_SOCK_Acceptor>, i.e., if <this> acceptor factory is in + * ACE_SOCK_Acceptor, i.e., if <this> acceptor factory is in * non-blocking mode, the <net_stream> will be in non-blocking mode * and vice versa. */ diff --git a/ACE/ace/SOCK_Dgram.h b/ACE/ace/SOCK_Dgram.h index c78b731db40..dc45f8c5c27 100644 --- a/ACE/ace/SOCK_Dgram.h +++ b/ACE/ace/SOCK_Dgram.h @@ -125,11 +125,11 @@ public: int flags = 0) const; /** - * Wait up to <timeout> amount of time to receive a datagram into - * <buf>. The <ACE_Time_Value> indicates how long to blocking - * trying to receive. If <timeout> == 0, the caller will block + * Wait up to @a timeout amount of time to receive a datagram into + * <buf>. The ACE_Time_Value indicates how long to blocking + * trying to receive. If @a timeout == 0, the caller will block * until action is possible, else will wait until the relative time - * specified in *<timeout> elapses). If <recv> times out a -1 is + * specified in *@a timeout elapses). If <recv> times out a -1 is * returned with <errno == ETIME>. If it succeeds the number of * bytes received is returned. */ @@ -140,11 +140,11 @@ public: const ACE_Time_Value *timeout) const; /** - * Wait up to <timeout> amount of time to send a datagram to - * <buf>. The <ACE_Time_Value> indicates how long to blocking - * trying to receive. If <timeout> == 0, the caller will block + * Wait up to @a timeout amount of time to send a datagram to + * <buf>. The ACE_Time_Value indicates how long to blocking + * trying to receive. If @a timeout == 0, the caller will block * until action is possible, else will wait until the relative time - * specified in *<timeout> elapses). If <send> times out a -1 is + * specified in *@a timeout elapses). If <send> times out a -1 is * returned with <errno == ETIME>. If it succeeds the number of * bytes sent is returned. */ diff --git a/ACE/ace/SOCK_IO.h b/ACE/ace/SOCK_IO.h index 252ec68d0cd..1da5908b03e 100644 --- a/ACE/ace/SOCK_IO.h +++ b/ACE/ace/SOCK_IO.h @@ -32,13 +32,13 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL * (e.g., send/recv). * * - * If <timeout> == 0, then the call behaves as a normal + * If @a timeout == 0, then the call behaves as a normal * send/recv call, i.e., for blocking sockets, the call will * block until action is possible; for non-blocking sockets, * -1 will be returned with errno == EWOULDBLOCK if no action is * immediately possible. - * If <timeout> != 0, the call will wait until the relative time - * specified in *<timeout> elapses. + * 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>. * If it succeeds the number of bytes transferred is returned. diff --git a/ACE/ace/SOCK_SEQPACK_Acceptor.h b/ACE/ace/SOCK_SEQPACK_Acceptor.h index ecff29af19c..7455600b985 100644 --- a/ACE/ace/SOCK_SEQPACK_Acceptor.h +++ b/ACE/ace/SOCK_SEQPACK_Acceptor.h @@ -122,8 +122,8 @@ public: // = Passive connection <accept> methods. /** - * Accept a new <ACE_SOCK_SEQPACK_Association> connection. A <timeout> of 0 - * means block forever, a <timeout> of {0, 0} means poll. <restart> + * Accept a new <ACE_SOCK_SEQPACK_Association> connection. A @a timeout of 0 + * means block forever, a @a timeout of {0, 0} means poll. <restart> * == 1 means "restart if interrupted," i.e., if errno == EINTR. * Note that <new_association> inherits the "blocking mode" of <this> * <ACE_SOCK_SEQPACK_Acceptor>, i.e., if <this> acceptor factory is in diff --git a/ACE/ace/SOCK_SEQPACK_Association.h b/ACE/ace/SOCK_SEQPACK_Association.h index 481f71a260b..d559a2e2009 100644 --- a/ACE/ace/SOCK_SEQPACK_Association.h +++ b/ACE/ace/SOCK_SEQPACK_Association.h @@ -44,17 +44,17 @@ class ACE_Message_Block; * * <buf> is the buffer to write from or receive into. * <len> is the number of bytes to transfer. - * The <timeout> parameter in the following methods indicates how - * long to blocking trying to transfer data. If <timeout> == 0, + * The @a timeout parameter in the following methods indicates how + * long to blocking trying to transfer data. If @a timeout == 0, * then the call behaves as a normal send/recv call, i.e., for * blocking sockets, the call will block until action is possible; * for non-blocking sockets, EWOULDBLOCK will be returned if no * action is immediately possible. - * If <timeout> != 0, the call will wait for data to arrive no longer - * than the relative time specified in *<timeout>. + * If @a timeout != 0, the call will wait for data to arrive no longer + * than the relative time specified in *@a timeout. * The "_n()" I/O methods keep looping until all the data has been * transferred. These methods also work for sockets in non-blocking - * mode i.e., they keep looping on EWOULDBLOCK. <timeout> is used + * mode i.e., they keep looping on EWOULDBLOCK. @a timeout is used * to make sure we keep making progress, i.e., the same timeout * value is used for every I/O operation in the loop and the timeout * is not counted down. diff --git a/ACE/ace/SPIPE_Connector.h b/ACE/ace/SPIPE_Connector.h index f9fc2455ecc..a0e1f36a318 100644 --- a/ACE/ace/SPIPE_Connector.h +++ b/ACE/ace/SPIPE_Connector.h @@ -41,7 +41,7 @@ public: /** * Actively connect and produce a <new_stream> if things go well. * The <remote_sap> is the address that we are trying to connect - * with. The <timeout> is the amount of time to wait 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 @@ -69,7 +69,7 @@ public: /** * Actively connect and produce a <new_stream> if things go well. * The <remote_sap> is the address that we are trying to connect - * with. The <timeout> is the amount of time to wait 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 diff --git a/ACE/ace/Select_Reactor_T.h b/ACE/ace/Select_Reactor_T.h index 638e71185c5..7573a3ab76b 100644 --- a/ACE/ace/Select_Reactor_T.h +++ b/ACE/ace/Select_Reactor_T.h @@ -287,11 +287,11 @@ public: ACE_Reactor_Mask); /** - * Remove the ACE_Event_Handler currently associated with <signum>. + * Remove the ACE_Event_Handler currently associated with @a signum. * <sigkey> is ignored in this implementation since there is only * one instance of a signal handler. Install the new disposition * (if given) and return the previous disposition (if desired by the - * caller). Returns 0 on success and -1 if <signum> is invalid. + * caller). Returns 0 on success and -1 if @a signum is invalid. */ virtual int remove_handler (int signum, ACE_Sig_Action *new_disp, @@ -418,11 +418,11 @@ public: * This wakeups the <ACE_Select_Reactor> if currently blocked in * <select>/<poll>. Pass over both the <Event_Handler> *and* the * <mask> to allow the caller to dictate which <Event_Handler> - * method the <Select_Reactor> will invoke. The <ACE_Time_Value> + * method the <Select_Reactor> will invoke. The ACE_Time_Value * indicates how long to blocking trying to notify the - * <Select_Reactor>. If <timeout> == 0, the caller will block until + * <Select_Reactor>. If @a timeout == 0, the caller will block until * action is possible, else will wait until the relative time - * specified in *<timeout> elapses). + * specified in *@a timeout elapses). */ virtual int notify (ACE_Event_Handler * = 0, ACE_Reactor_Mask = ACE_Event_Handler::EXCEPT_MASK, @@ -515,7 +515,7 @@ public: ACE_Event_Handler **eh = 0); /** - * Check to see if <signum> is associated with a valid Event_Handler + * Check to see if @a signum is associated with a valid Event_Handler * bound to a signal. Return the <eh> associated with this * <handler> if <eh> != 0. */ diff --git a/ACE/ace/Sig_Handler.h b/ACE/ace/Sig_Handler.h index 31ca260b7a6..44360301087 100644 --- a/ACE/ace/Sig_Handler.h +++ b/ACE/ace/Sig_Handler.h @@ -34,11 +34,11 @@ class ACE_Sig_Action; * objects to handle signals in a way that avoids the use of * global/static variables and functions. * - * Using this class a program can register an <ACE_Event_Handler> + * Using this class a program can register an ACE_Event_Handler * with the <ACE_Sig_Handler> in order to handle a designated - * <signum>. When a signal occurs that corresponds to this - * <signum>, the <handle_signal> method of the registered - * <ACE_Event_Handler> is invoked automatically. + * @a signum. When a signal occurs that corresponds to this + * @a signum, the <handle_signal> method of the registered + * ACE_Event_Handler is invoked automatically. */ class ACE_Export ACE_Sig_Handler { @@ -49,8 +49,8 @@ public: // = Registration and removal methods. /** - * Add a new <ACE_Event_Handler> and a new sigaction associated with - * <signum>. Passes back the existing <ACE_Event_Handler> and its + * Add a new ACE_Event_Handler and a new sigaction associated with + * @a signum. Passes back the existing ACE_Event_Handler and its * sigaction if pointers are non-zero. Returns -1 on failure and >= * 0 on success. */ @@ -61,11 +61,11 @@ public: ACE_Sig_Action *old_disp = 0); /** - * Remove the <ACE_Event_Handler> currently associated with - * <signum>. <sigkey> is ignored in this implementation since there + * Remove the ACE_Event_Handler currently associated with + * @a signum. <sigkey> is ignored in this implementation since there * is only one instance of a signal handler. Install the new * disposition (if given) and return the previous disposition (if - * desired by the caller). Returns 0 on success and -1 if <signum> + * desired by the caller). Returns 0 on success and -1 if @a signum * is invalid. */ virtual int remove_handler (int signum, @@ -82,10 +82,10 @@ public: // = Set/get the handler associated with a particular signal. - /// Return the <ACE_Sig_Handler> associated with <signum>. + /// Return the <ACE_Sig_Handler> associated with @a signum. virtual ACE_Event_Handler *handler (int signum); - /// Set a new <ACE_Event_Handler> that is associated with <signum>. + /// Set a new ACE_Event_Handler that is associated with @a signum. /// Return the existing handler. virtual ACE_Event_Handler *handler (int signum, ACE_Event_Handler *); @@ -108,7 +108,7 @@ protected: // = These methods and data members are shared by derived classes. /** - * Set a new <ACE_Event_Handler> that is associated with <signum>. + * Set a new ACE_Event_Handler that is associated with @a signum. * Return the existing handler. Does not acquire any locks so that * it can be called from a signal handler, such as <dispatch>. */ @@ -119,8 +119,8 @@ protected: * This implementation method is called by <register_handler> and * <dispatch>. It doesn't do any locking so that it can be called * within a signal handler, such as <dispatch>. It adds a new - * <ACE_Event_Handler> and a new sigaction associated with <signum>. - * Passes back the existing <ACE_Event_Handler> and its sigaction if + * ACE_Event_Handler and a new sigaction associated with @a signum. + * Passes back the existing ACE_Event_Handler and its sigaction if * pointers are non-zero. Returns -1 on failure and >= 0 on * success. */ @@ -152,8 +152,8 @@ private: * * Using this class a program can register one or more * ACE_Event_Handler with the ACE_Sig_Handler in order to - * handle a designated <signum>. When a signal occurs that - * corresponds to this <signum>, the <handle_signal> methods of + * handle a designated @a signum. When a signal occurs that + * corresponds to this @a signum, the <handle_signal> methods of * all the registered ACE_Event_Handlers are invoked * automatically. */ @@ -163,7 +163,7 @@ public: // = Registration and removal methods. /** * Add a new ACE_Event_Handler and a new sigaction associated with - * <signum>. Passes back the existing ACE_Event_Handler and its + * @a signum. Passes back the existing ACE_Event_Handler and its * sigaction if pointers are non-zero. Returns -1 on failure and * a <sigkey> that is >= 0 on success. */ @@ -174,12 +174,12 @@ public: ACE_Sig_Action *old_disp = 0); /** - * Remove an <ACE_Event_Handler> currently associated with <signum>. + * Remove an ACE_Event_Handler currently associated with @a signum. * We remove the handler if (1) its <sigkey> matches the <sigkey> * passed as a parameter or (2) if we've been told to remove all the * handlers, i.e., <sigkey> == -1. If a new disposition is given it * is installed and the previous disposition is returned (if desired - * by the caller). Returns 0 on success and -1 if <signum> is + * by the caller). Returns 0 on success and -1 if @a signum is * invalid. */ virtual int remove_handler (int signum, @@ -194,7 +194,7 @@ public: virtual ACE_Event_Handler *handler (int signum); /** - * Set a new <ACE_Event_Handler> that is associated with SIGNUM at + * Set a new ACE_Event_Handler that is associated with SIGNUM at * the head of the list of signals. Return the existing handler * that was at the head. */ @@ -204,7 +204,7 @@ public: /** * Callback routine registered with sigaction(2) that dispatches the * <handle_signal> method of all the pre-registered - * ACE_Event_Handlers for <signum> + * ACE_Event_Handlers for @a signum */ static void dispatch (int signum, siginfo_t *, ucontext_t *); diff --git a/ACE/ace/Signal.h b/ACE/ace/Signal.h index edb091c1cbd..188bb770bd9 100644 --- a/ACE/ace/Signal.h +++ b/ACE/ace/Signal.h @@ -118,7 +118,7 @@ public: /** * Assigns the various fields of a <sigaction> struct and registers - * the <handler> to process signal <signum> via the <sigaction> + * the <handler> to process signal @a signum via the <sigaction> * function. */ ACE_Sig_Action (ACE_SignalHandler handler, @@ -128,7 +128,7 @@ public: /** * Assigns the various fields of a <sigaction> struct and registers - * the <handler> to process signal <signum> via the <sigaction> + * the <handler> to process signal @a signum via the <sigaction> * function. */ ACE_Sig_Action (ACE_SignalHandler handler, diff --git a/ACE/ace/Stream.h b/ACE/ace/Stream.h index 13a36b78f2b..59b440d02d0 100644 --- a/ACE/ace/Stream.h +++ b/ACE/ace/Stream.h @@ -132,18 +132,18 @@ public: // = Blocking data transfer operations /** - * Send the message <mb> down the stream, starting at the Module - * below the Stream head. Wait for upto <timeout> amount of + * Send the message @a mb down the stream, starting at the Module + * below the Stream head. Wait for upto @a timeout amount of * absolute time for the operation to complete (or block forever if - * <timeout> == 0). + * @a timeout == 0). */ virtual int put (ACE_Message_Block *mb, ACE_Time_Value *timeout = 0); /** - * Read the message <mb> that is stored in the stream head. - * Wait for upto <timeout> amount of absolute time for the operation - * to complete (or block forever if <timeout> == 0). + * Read the message @a mb that is stored in the stream head. + * Wait for upto @a timeout amount of absolute time for the operation + * to complete (or block forever if @a timeout == 0). */ virtual int get (ACE_Message_Block *&mb, ACE_Time_Value *timeout = 0); diff --git a/ACE/ace/Svc_Handler.h b/ACE/ace/Svc_Handler.h index 76027b9e409..9d3dd857de4 100644 --- a/ACE/ace/Svc_Handler.h +++ b/ACE/ace/Svc_Handler.h @@ -264,7 +264,7 @@ public: // = Initialization and termination methods. /** * Constructor initializes the <thr_mgr> and <mq> by passing them - * down to the <ACE_Task> base class. The <reactor> is passed to + * down to the ACE_Task base class. The <reactor> is passed to * the ACE_Event_Handler. The <max_buffer_size> and * <relative_timeout> are used to determine at what point to flush * the <mq>. By default, there's no buffering at all. The @@ -282,7 +282,7 @@ public: /** * Insert the ACE_Message_Block chain rooted at <message_block> - * into the ACE_Message_Queue with the designated <timeout>. The + * into the ACE_Message_Queue with the designated @a timeout. The * <flush> method will be called if this <put> causes the number of * bytes to exceed the maximum buffer size or if the timeout period * has elapsed. diff --git a/ACE/ace/TLI_Acceptor.h b/ACE/ace/TLI_Acceptor.h index e7855b83c8f..7a6577800ad 100644 --- a/ACE/ace/TLI_Acceptor.h +++ b/ACE/ace/TLI_Acceptor.h @@ -73,8 +73,8 @@ public: // = Passive connection acceptance method. /** - * Accept a new data transfer connection. A <timeout> of 0 means - * block forever, a <timeout> of {0, 0} means poll. <restart> == 1 + * Accept a new data transfer connection. A @a timeout of 0 means + * block forever, a @a timeout of {0, 0} means poll. <restart> == 1 * means "restart if interrupted." */ int accept (ACE_TLI_Stream &new_tli_sap, diff --git a/ACE/ace/TLI_Connector.h b/ACE/ace/TLI_Connector.h index d8e8f381bfb..74e477a7b6b 100644 --- a/ACE/ace/TLI_Connector.h +++ b/ACE/ace/TLI_Connector.h @@ -42,7 +42,7 @@ public: /** * Actively connect and produce a <new_stream> if things go well. * The <remote_sap> is the address that we are trying to connect - * with. The <timeout> is the amount of time to wait 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 @@ -70,7 +70,7 @@ public: /** * Actively connect and produce a <new_stream> if things go well. * The <remote_sap> is the address that we are trying to connect - * with. The <timeout> is the amount of time to wait 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 diff --git a/ACE/ace/Task_Ex_T.h b/ACE/ace/Task_Ex_T.h index 79102e4be8f..6c341560818 100644 --- a/ACE/ace/Task_Ex_T.h +++ b/ACE/ace/Task_Ex_T.h @@ -89,38 +89,38 @@ public: // Should be protected: // = Enqueue and dequeue methods. - // For the following five method if <timeout> == 0, the caller will + // For the following five method if @a timeout == 0, the caller will // block until action is possible, else will wait until the - // <{absolute}> time specified in *<timeout> elapses). These calls + // <{absolute}> time specified in *@a timeout elapses). These calls // will return, however, when queue is closed, deactivated, when a // signal occurs, or if the time specified in timeout elapses, (in // which case errno = EWOULDBLOCK). - /// Insert message into the message queue. Note that <timeout> uses + /// Insert message into the message queue. Note that @a timeout uses /// <{absolute}> time rather than <{relative}> time. int putq (ACE_MESSAGE_TYPE *, ACE_Time_Value *timeout = 0); /** * Extract the first message from the queue (blocking). Note that - * <timeout> uses <{absolute}> time rather than <{relative}> time. + * @a timeout uses <{absolute}> time rather than <{relative}> time. * Returns number of items in queue if the call succeeds or -1 otherwise. */ int getq (ACE_MESSAGE_TYPE *&mb, ACE_Time_Value *timeout = 0); - /// Return a message to the queue. Note that <timeout> uses + /// Return a message to the queue. Note that @a timeout uses /// <{absolute}> time rather than <{relative}> time. int ungetq (ACE_MESSAGE_TYPE *, ACE_Time_Value *timeout = 0); /** * Turn the message around and send it back down the Stream. Note - * that <timeout> uses <{absolute}> time rather than <{relative}> + * that @a timeout uses <{absolute}> time rather than <{relative}> * time. */ int reply (ACE_MESSAGE_TYPE *, ACE_Time_Value *timeout = 0); /** * Transfer message to the adjacent ACE_Task_Ex in a ACE_Stream. Note - * that <timeout> uses <{absolute}> time rather than <{relative}> + * that @a timeout uses <{absolute}> time rather than <{relative}> * time. */ int put_next (ACE_MESSAGE_TYPE *msg, ACE_Time_Value *timeout = 0); diff --git a/ACE/ace/Task_T.h b/ACE/ace/Task_T.h index af029a42ec8..5531e136b0b 100644 --- a/ACE/ace/Task_T.h +++ b/ACE/ace/Task_T.h @@ -69,25 +69,25 @@ public: // Should be protected: // = Enqueue and dequeue methods. - // For the following five method if <timeout> == 0, the caller will + // For the following five method if @a timeout == 0, the caller will // block until action is possible, else will wait until the - // <{absolute}> time specified in *<timeout> elapses). These calls + // <{absolute}> time specified in *@a timeout elapses). These calls // will return, however, when queue is closed, deactivated, when a // signal occurs, or if the time specified in timeout elapses, (in // which case errno = EWOULDBLOCK). - /// Insert message into the message queue. Note that <timeout> uses + /// Insert message into the message queue. Note that @a timeout uses /// <{absolute}> time rather than <{relative}> time. int putq (ACE_Message_Block *, ACE_Time_Value *timeout = 0); /** * Extract the first message from the queue (blocking). Note that - * <timeout> uses <{absolute}> time rather than <{relative}> time. + * @a timeout uses <{absolute}> time rather than <{relative}> time. * Returns number of items in queue if the call succeeds or -1 otherwise. */ int getq (ACE_Message_Block *&mb, ACE_Time_Value *timeout = 0); - /// Return a message to the queue. Note that <timeout> uses + /// Return a message to the queue. Note that @a timeout uses /// <{absolute}> time rather than <{relative}> time. int ungetq (ACE_Message_Block *, ACE_Time_Value *timeout = 0); @@ -106,7 +106,7 @@ public: // Should be protected: /** * Transfer message to the adjacent ACE_Task in a ACE_Stream. Note - * that <timeout> uses <{absolute}> time rather than <{relative}> + * that @a timeout uses <{absolute}> time rather than <{relative}> * time. */ int put_next (ACE_Message_Block *msg, ACE_Time_Value *timeout = 0); diff --git a/ACE/ace/Thread_Manager.h b/ACE/ace/Thread_Manager.h index 616e972ecf8..c2b2c6dc1d9 100644 --- a/ACE/ace/Thread_Manager.h +++ b/ACE/ace/Thread_Manager.h @@ -688,11 +688,11 @@ public: // = Send signals to one or more threads without blocking. /** - * Send <signum> to all stopped threads. Not supported on platforms + * Send @a signum to all stopped threads. Not supported on platforms * that do not have advanced signal support, such as Win32. - * Send the <signum> to a single thread. Not supported on platforms + * Send the @a signum to a single thread. Not supported on platforms * that do not have advanced signal support, such as Win32. - * Send <signum> to a group of threads, not supported on platforms + * Send @a signum to a group of threads, not supported on platforms * that do not have advanced signal support, such as Win32. */ int kill_all (int signum); @@ -771,13 +771,13 @@ public: int resume_task (ACE_Task_Base *task); /** - * Send a signal <signum> to all threads in an <ACE_Task>. + * Send a signal @a signum to all threads in an ACE_Task. */ int kill_task (ACE_Task_Base *task, int signum); /** - * Cancel all threads in an <ACE_Task>. If <async_cancel> is non-0, + * Cancel all threads in an ACE_Task. If <async_cancel> is non-0, * then asynchronously cancel these threads if the OS platform * supports cancellation. Otherwise, perform a "cooperative" * cancellation. @@ -1068,7 +1068,7 @@ protected: int suspend_thr (ACE_Thread_Descriptor *td, int = 0); - /// Send signal <signum> to the thread described in <tda>. + /// Send signal @a signum to the thread described in <tda>. int kill_thr (ACE_Thread_Descriptor *td, int signum); diff --git a/ACE/ace/Token.h b/ACE/ace/Token.h index 530cbae2057..9344809ca51 100644 --- a/ACE/ace/Token.h +++ b/ACE/ace/Token.h @@ -108,7 +108,7 @@ public: /** * Acquire the token, sleeping until it is obtained or until the - * expiration of <timeout>, which is treated as "absolute" time. If + * expiration of @a timeout, which is treated as "absolute" time. If * some other thread currently holds the token then <sleep_hook> is * called before our thread goes to sleep. This <sleep_hook> can be * used by the requesting thread to unblock a token-holder that is @@ -116,7 +116,7 @@ public: * ACE_Reactor uses this functionality). Return values: 0 if * acquires without calling <sleep_hook> 1 if <sleep_hook> is * called. 2 if the token is signaled. -1 if failure or timeout - * occurs (if timeout occurs errno == ETIME) If <timeout> == + * occurs (if timeout occurs errno == ETIME) If @a timeout == * <&ACE_Time_Value::zero> then acquire has polling semantics (and * does *not* call <sleep_hook>). */ @@ -154,7 +154,7 @@ public: * thing to do (since it makes it possible for shared data to be * changed unexpectedly) so use with caution... This method * maintians the original token priority. As in <acquire>, the - * <timeout> value is an absolute time. + * @a timeout value is an absolute time. */ int renew (int requeue_position = 0, ACE_Time_Value *timeout = 0); diff --git a/ACE/ace/WFMO_Reactor.h b/ACE/ace/WFMO_Reactor.h index a65b28cb691..2c8f2bec20d 100644 --- a/ACE/ace/WFMO_Reactor.h +++ b/ACE/ace/WFMO_Reactor.h @@ -510,10 +510,10 @@ public: * Special trick to unblock <WaitForMultipleObjects> when updates * occur. All we do is enqueue <event_handler> and <mask> onto the * ACE_Message_Queue and wakeup the <WFMO_Reactor> by signaling - * its <ACE_Event> handle. The <ACE_Time_Value> indicates how long - * to blocking trying to notify the <WFMO_Reactor>. If <timeout> == + * its <ACE_Event> handle. The ACE_Time_Value indicates how long + * to blocking trying to notify the <WFMO_Reactor>. If @a timeout == * 0, the caller will block until action is possible, else will wait - * until the relative time specified in <timeout> elapses). + * until the relative time specified in @a timeout elapses). */ virtual int notify (ACE_Event_Handler *event_handler = 0, ACE_Reactor_Mask mask = ACE_Event_Handler::EXCEPT_MASK, @@ -831,7 +831,7 @@ public: ACE_Reactor_Mask mask); /** - * Register <new_sh> to handle the signal <signum> using the + * Register <new_sh> to handle the signal @a signum using the * <new_disp>. Returns the <old_sh> that was previously registered * (if any), along with the <old_disp> of the signal handler. */ @@ -883,11 +883,11 @@ public: ACE_Reactor_Mask); /** - * Remove the ACE_Event_Handler currently associated with <signum>. + * Remove the ACE_Event_Handler currently associated with @a signum. * <sigkey> is ignored in this implementation since there is only * one instance of a signal handler. Install the new disposition * (if given) and return the previous disposition (if desired by the - * caller). Returns 0 on success and -1 if <signum> is invalid. + * caller). Returns 0 on success and -1 if @a signum is invalid. */ virtual int remove_handler (int signum, ACE_Sig_Action *new_disp, @@ -1029,10 +1029,10 @@ public: /** * Wakeup one <ACE_WFMO_Reactor> thread if it is currently blocked - * in <WaitForMultipleObjects>. The <ACE_Time_Value> indicates how + * in <WaitForMultipleObjects>. The ACE_Time_Value indicates how * long to blocking trying to notify the <WFMO_Reactor>. If - * <timeout> == 0, the caller will block until action is possible, - * else will wait until the relative time specified in <timeout> + * @a timeout == 0, the caller will block until action is possible, + * else will wait until the relative time specified in @a timeout * elapses). */ virtual int notify (ACE_Event_Handler * = 0, @@ -1087,7 +1087,7 @@ public: ACE_Event_Handler **event_handler = 0); /** - * Check to see if <signum> is associated with a valid Event_Handler + * Check to see if @a signum is associated with a valid Event_Handler * bound to a signal. Return the <event_handler> associated with * this <handler> if <event_handler> != 0. */ diff --git a/ACE/ace/XTI_ATM_Mcast.h b/ACE/ace/XTI_ATM_Mcast.h index cb1ba0bf2d3..23fbc0c6381 100644 --- a/ACE/ace/XTI_ATM_Mcast.h +++ b/ACE/ace/XTI_ATM_Mcast.h @@ -44,7 +44,7 @@ public: /** * Actively connect and produce a <new_stream> if things go well. * The <remote_sap> is the address that we are trying to connect - * with. The <timeout> is the amount of time to wait 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 @@ -72,7 +72,7 @@ public: /** * Actively connect and produce a <new_stream> if things go well. * The <remote_sap> is the address that we are trying to connect - * with. The <timeout> is the amount of time to wait 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 @@ -100,7 +100,7 @@ public: /** * Actively add a leaf to the currently connected stream (i.e., * multicast). The <remote_sap> is the address of the leaf that we - * are trying to add. The <timeout> is the amount of time to wait to + * 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 |