From 1e7cad4d73c38e5430a8771b7f21046f8eae0d99 Mon Sep 17 00:00:00 2001 From: Johnny Willemsen Date: Thu, 15 Feb 2007 13:51:31 +0000 Subject: Thu Feb 15 13:50:58 UTC 2007 Johnny Willemsen --- ACE/ChangeLog | 36 ++++++++++++++++++++++++ ACE/ace/CDR_Stream.h | 10 +++---- ACE/ace/Connector.h | 2 +- ACE/ace/DEV_IO.h | 12 ++++---- ACE/ace/FIFO_Recv.h | 4 +-- ACE/ace/FIFO_Send.h | 4 +-- ACE/ace/FIFO_Send_Msg.h | 4 +-- ACE/ace/FILE_IO.h | 14 +++++----- ACE/ace/INET_Addr.h | 2 +- ACE/ace/Local_Memory_Pool.h | 4 +-- ACE/ace/MEM_IO.h | 32 +++++++++++----------- ACE/ace/MEM_SAP.h | 4 +-- ACE/ace/MEM_Stream.h | 12 ++++---- ACE/ace/MMAP_Memory_Pool.h | 6 ++-- ACE/ace/Malloc_Base.h | 4 +-- ACE/ace/Mem_Map.h | 10 +++---- ACE/ace/Message_Block.h | 2 +- ACE/ace/OS_NS_unistd.h | 4 +-- ACE/ace/Pipe.h | 14 +++++----- ACE/ace/Process_Manager.h | 2 +- ACE/ace/QoS/SOCK_Dgram_Mcast_QoS.h | 2 +- ACE/ace/SOCK_Dgram.h | 16 +++++------ ACE/ace/SOCK_Dgram_Mcast.h | 4 +-- ACE/ace/SOCK_IO.h | 20 +++++++------- ACE/ace/SOCK_SEQPACK_Association.h | 12 ++++---- ACE/ace/SPIPE_Stream.h | 18 ++++++------ ACE/ace/Service_Types.h | 2 +- ACE/ace/Shared_Memory_Pool.h | 2 +- ACE/ace/Stream.h | 4 +-- ACE/ace/Task.h | 8 +++--- ACE/ace/Thread.h | 10 +++---- ACE/ace/Thread_Manager.h | 56 +++++++++++++++++++------------------- ACE/ace/UPIPE_Stream.h | 2 +- 33 files changed, 187 insertions(+), 151 deletions(-) diff --git a/ACE/ChangeLog b/ACE/ChangeLog index d031d82b4fc..2d2a7aa5331 100644 --- a/ACE/ChangeLog +++ b/ACE/ChangeLog @@ -1,3 +1,39 @@ +Thu Feb 15 13:50:58 UTC 2007 Johnny Willemsen + + * ace/CDR_Stream.h: + * ace/Connector.h: + * ace/DEV_IO.h: + * ace/FIFO_Recv.h: + * ace/FIFO_Send.h: + * ace/FIFO_Send_Msg.h: + * ace/FILE_IO.h: + * ace/INET_Addr.h: + * ace/Local_Memory_Pool.h: + * ace/Malloc_Base.h: + * ace/MEM_IO.h: + * ace/Mem_Map.h: + * ace/MEM_SAP.h: + * ace/MEM_Stream.h: + * ace/Message_Block.h: + * ace/MMAP_Memory_Pool.h: + * ace/OS_NS_unistd.h: + * ace/Pipe.h: + * ace/Process_Manager.h: + * ace/QoS/SOCK_Dgram_Mcast_QoS.h: + * ace/Service_Types.h: + * ace/Shared_Memory_Pool.h: + * ace/SOCK_Dgram.h: + * ace/SOCK_Dgram_Mcast.h: + * ace/SOCK_IO.h: + * ace/SOCK_SEQPACK_Association.h: + * ace/SPIPE_Stream.h: + * ace/Stream.h: + * ace/Task.h: + * ace/Thread.h: + * ace/Thread_Manager.h: + * ace/UPIPE_Stream.h: + Doxygen improvements + Thu Feb 15 13:38:58 UTC 2007 Johnny Willemsen * ace/ATM_Connector.h: diff --git a/ACE/ace/CDR_Stream.h b/ACE/ace/CDR_Stream.h index 5e94707665e..b189fbd6d28 100644 --- a/ACE/ace/CDR_Stream.h +++ b/ACE/ace/CDR_Stream.h @@ -393,9 +393,9 @@ public: size_t current_alignment (void) const; /** - * Returns (in ) the next position in the buffer aligned to + * Returns (in @a buf) the next position in the buffer aligned to * @a size, it advances the Message_Block wr_ptr past the data - * (i.e., + @a size). If necessary it grows the Message_Block + * (i.e., @a buf + @a size). If necessary it grows the Message_Block * buffer. Sets the good_bit to false and returns a -1 on failure. */ int adjust (size_t size, @@ -468,7 +468,7 @@ private: /** - * Grow the CDR stream. When it returns contains a pointer to + * Grow the CDR stream. When it returns @a buf contains a pointer to * memory in the CDR stream, with at least @a size bytes ahead of it * and aligned to an boundary. It moved the to . @@ -1093,7 +1093,7 @@ protected: /** * Exposes the stream implementation of , this is useful in * many cases to minimize memory allocations during marshaling. - * On success will contain a contiguous area in the CDR stream + * On success @a buf will contain a contiguous area in the CDR stream * that can hold @a size bytes aligned to . * Results */ @@ -1186,7 +1186,7 @@ protected: /** * Exposes the stream implementation of , this is useful in * many cases to minimize memory allocations during marshaling. - * On success will contain a contiguous area in the CDR stream + * On success @a buf will contain a contiguous area in the CDR stream * that can hold @a size bytes aligned to . * Results */ diff --git a/ACE/ace/Connector.h b/ACE/ace/Connector.h index f92ebea99a9..427679c1673 100644 --- a/ACE/ace/Connector.h +++ b/ACE/ace/Connector.h @@ -349,7 +349,7 @@ protected: /// Calls to shutdown the Connector gracefully. virtual int fini (void); - /// Default version returns address info in . + /// Default version returns address info in @a buf. virtual int info (ACE_TCHAR **strp, size_t length) const; // = Service management hooks. diff --git a/ACE/ace/DEV_IO.h b/ACE/ace/DEV_IO.h index 172e7db8f72..9a5d30e3217 100644 --- a/ACE/ace/DEV_IO.h +++ b/ACE/ace/DEV_IO.h @@ -46,10 +46,10 @@ public: ACE_DEV_IO (void); // = Various send operations. - /// send upto bytes in . + /// send upto @a n bytes in @a buf. ssize_t send (const void *buf, size_t n) const; - /// Recv upto bytes in . + /// Recv upto @a n bytes in @a buf. ssize_t recv (void *buf, size_t n) const; /// Send n bytes, keep trying until n are sent. @@ -61,9 +61,9 @@ public: * * Notes on common parameters: * - * is the buffer to write from or receive into. + * @a buf is the buffer to write from or receive into. * - * is the number of bytes to transfer. + * @a len is the number of bytes to transfer. * * The @a timeout parameter in the following methods indicates how * long to blocking trying to transfer data. If @a timeout == 0, @@ -146,10 +146,10 @@ public: */ ssize_t recv (size_t n, ...) const; - /// Send bytes via Win32 WriteFile using overlapped I/O. + /// Send @a n bytes via Win32 WriteFile using overlapped I/O. ssize_t send (const void *buf, size_t n, ACE_OVERLAPPED *overlapped) const; - /// Recv bytes via Win32 ReadFile using overlapped I/O. + /// Recv @a n bytes via Win32 ReadFile using overlapped I/O. ssize_t recv (void *buf, size_t n, ACE_OVERLAPPED *overlapped) const; /// Dump the state of an object. diff --git a/ACE/ace/FIFO_Recv.h b/ACE/ace/FIFO_Recv.h index fc4ec2222f3..fa18cf291a5 100644 --- a/ACE/ace/FIFO_Recv.h +++ b/ACE/ace/FIFO_Recv.h @@ -57,10 +57,10 @@ public: /// Close down the named pipe. int close (void); - /// Recv of up to bytes. + /// Recv @a buf of up to @a len bytes. ssize_t recv (void *buf, size_t len); - /// Recv of exactly bytes (block until done). + /// Recv @a buf of exactly @a len bytes (block until done). ssize_t recv_n (void *buf, size_t len); /// Dump the state of an object. diff --git a/ACE/ace/FIFO_Send.h b/ACE/ace/FIFO_Send.h index 45e02c87c38..51a14508114 100644 --- a/ACE/ace/FIFO_Send.h +++ b/ACE/ace/FIFO_Send.h @@ -51,10 +51,10 @@ public: mode_t perms = ACE_DEFAULT_FILE_PERMS, LPSECURITY_ATTRIBUTES sa = 0); - /// Send of up to bytes. + /// Send @a buf of up to @a len bytes. ssize_t send (const void *buf, size_t len); - /// Send of exactly bytes (block until done). + /// Send @a buf of exactly @a len bytes (block until done). ssize_t send_n (const void *buf, size_t len); /// Dump the state of an object. diff --git a/ACE/ace/FIFO_Send_Msg.h b/ACE/ace/FIFO_Send_Msg.h index 8272ec6c819..a2e0affce8a 100644 --- a/ACE/ace/FIFO_Send_Msg.h +++ b/ACE/ace/FIFO_Send_Msg.h @@ -55,10 +55,10 @@ public: mode_t perms = ACE_DEFAULT_FILE_PERMS, LPSECURITY_ATTRIBUTES sa = 0); - /// Send of up to bytes. + /// Send @a buf of up to @a len bytes. ssize_t send (const ACE_Str_Buf &msg); - /// Send of exactly bytes (block until done). + /// Send @a buf of exactly @a len bytes (block until done). ssize_t send (const void *buf, size_t len); #if defined (ACE_HAS_STREAM_PIPES) diff --git a/ACE/ace/FILE_IO.h b/ACE/ace/FILE_IO.h index ada2266c618..8fc0a068942 100644 --- a/ACE/ace/FILE_IO.h +++ b/ACE/ace/FILE_IO.h @@ -50,10 +50,10 @@ public: /// Default constructor. ACE_FILE_IO (void); - /// send upto bytes in . + /// send upto @a n bytes in @a buf. ssize_t send (const void *buf, size_t n) const; - /// Recv upto bytes in . + /// Recv upto @a n bytes in @a buf. ssize_t recv (void *buf, size_t n) const; /// Send n bytes, keep trying until n are sent. @@ -117,17 +117,17 @@ public: */ ssize_t recv (size_t n, ...) const; - /// Send bytes via Win32 WriteFile using overlapped I/O. + /// Send @a n bytes via Win32 WriteFile using overlapped I/O. ssize_t send (const void *buf, size_t n, ACE_OVERLAPPED *overlapped) const; - /// Recv bytes via Win32 ReadFile using overlapped I/O. + /// Recv @a n bytes via Win32 ReadFile using overlapped I/O. ssize_t recv (void *buf, size_t n, ACE_OVERLAPPED *overlapped) const; - /// Send an of size to the file. + /// Send an of size @a n to the file. ssize_t sendv (const iovec iov[], int n) const; @@ -141,12 +141,12 @@ public: */ ssize_t recvv (iovec *io_vec); - /// Send an of size to the file. Will block until all + /// Send an of size @a n to the file. Will block until all /// bytes are sent or an error occurs. ssize_t sendv_n (const iovec iov[], int n) const; - /// Receive an of size to the file. + /// Receive an of size @a n to the file. ssize_t recvv_n (iovec iov[], int n) const; diff --git a/ACE/ace/INET_Addr.h b/ACE/ace/INET_Addr.h index 2e9453047ef..e0fdd8c4001 100644 --- a/ACE/ace/INET_Addr.h +++ b/ACE/ace/INET_Addr.h @@ -242,7 +242,7 @@ public: * is enabled then is converted into network * byte order, otherwise it is assumed to be in network byte order * already and are passed straight through. The size of the address - * is specified in the parameter. + * is specified in the @a len parameter. * If is non-zero, IPv6 support has been compiled in, and * is an IPv4 address, then this address is set to the IPv4-mapped * IPv6 address of it. diff --git a/ACE/ace/Local_Memory_Pool.h b/ACE/ace/Local_Memory_Pool.h index caf22055273..d6862553eb4 100644 --- a/ACE/ace/Local_Memory_Pool.h +++ b/ACE/ace/Local_Memory_Pool.h @@ -82,13 +82,13 @@ public: /** * Change the protection of the pages of the mapped region to - * starting at base_addr_> up to bytes. If == -1 + * starting at base_addr_> up to @a len bytes. If @a len == -1 * then change protection of all pages in the mapped region. */ virtual int protect (ssize_t len = -1, int prot = PROT_RDWR); /// Change the protection of the pages of the mapped region to - /// starting at up to bytes. + /// starting at up to @a len bytes. virtual int protect (void *addr, size_t len, int prot = PROT_RDWR); #if defined (ACE_WIN32) diff --git a/ACE/ace/MEM_IO.h b/ACE/ace/MEM_IO.h index 1b49fa8a094..79d63f8bd5d 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 @a timeout amount of time to send . If + * Wait to to @a timeout amount of time to send @a buf. If * times out a -1 is returned with . If it succeeds * the number of bytes sent is returned. */ virtual ssize_t send_buf (ACE_MEM_SAP_Node *buf, @@ -67,8 +67,8 @@ public: const ACE_Time_Value *timeout); /** - * Convert the buffer offset to absolute address to . - * Return the size of valid information containing in the , + * Convert the buffer offset to absolute address to @a buf. + * Return the size of valid information containing in the @a buf, * -1 if is not initialized. */ ssize_t get_buf_len (const ACE_OFF_T off, ACE_MEM_SAP_Node *&buf); @@ -128,7 +128,7 @@ public: const ACE_Time_Value *timeout); /** - * Wait to to @a timeout amount of time to send . If + * Wait to to @a timeout amount of time to send @a buf. If * times out a -1 is returned with . If it succeeds * the number of bytes sent is returned. */ virtual ssize_t send_buf (ACE_MEM_SAP_Node *buf, @@ -196,29 +196,29 @@ public: */ int fini (void); - /// Send an byte buffer to the other process using shm_malloc_ + /// Send an @a n byte buffer to the other process using shm_malloc_ /// connected thru the socket. ssize_t send (const void *buf, size_t n, int flags) ; - /// Recv an byte buffer from the shm_malloc_ thru connected socket. + /// Recv an @a n byte buffer from the shm_malloc_ thru connected socket. ssize_t recv (void *buf, size_t n, int flags) ; - /// Send an byte buffer to the other process using shm_malloc_ + /// Send an @a n byte buffer to the other process using shm_malloc_ /// connected thru the socket. ssize_t send (const void *buf, size_t n) ; - /// Recv an byte buffer from the shm_malloc_ thru connected socket. + /// Recv an @a n byte buffer from the shm_malloc_ thru connected socket. ssize_t recv (void *buf, size_t n) ; /** - * Wait to to @a timeout amount of time to send up to bytes into - * from (uses the call). If times out + * Wait to to @a timeout amount of time to send up to @a n bytes into + * @a buf from (uses the call). If times out * a -1 is returned with . If it succeeds the * number of bytes sent is returned. */ @@ -227,8 +227,8 @@ public: const ACE_Time_Value *timeout); /** - * Wait to to @a timeout amount of time to send up to bytes into - * from (uses the call). If times out + * Wait to to @a timeout amount of time to send up to @a n bytes into + * @a buf from (uses the call). If times out * a -1 is returned with . If it succeeds the * number of bytes sent is returned. */ @@ -246,8 +246,8 @@ public: const ACE_Time_Value *timeout); /** - * Wait up to @a timeout amount of time to receive up to bytes - * into from (uses the call). If times + * Wait up to @a timeout amount of time to receive up to @a n bytes + * into @a buf from (uses the call). If times * out a -1 is returned with . If it succeeds the * number of bytes received is returned. */ @@ -256,8 +256,8 @@ public: const ACE_Time_Value *timeout); /** - * Wait up to @a timeout amount of time to receive up to bytes - * into from (uses the call). If times + * Wait up to @a timeout amount of time to receive up to @a n bytes + * into @a buf from (uses the call). If times * out a -1 is returned with . 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 01da250e38c..f9b8f1c7d8e 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 @a timeout amount of time to send . If + * Wait to to @a timeout amount of time to send @a buf. If * times out a -1 is returned with . If it succeeds * the number of bytes sent is returned. */ virtual ssize_t send_buf (ACE_MEM_SAP_Node *buf, @@ -121,7 +121,7 @@ public: /// not initialized. ACE_MEM_SAP_Node *acquire_buffer (const ssize_t size); - /// release a buffer pointed by . Return -1 if the + /// release a buffer pointed by @a buf. Return -1 if the /// is not initialized. int release_buffer (ACE_MEM_SAP_Node *buf); diff --git a/ACE/ace/MEM_Stream.h b/ACE/ace/MEM_Stream.h index 95a86b3ddf2..6bb3e6fa9e7 100644 --- a/ACE/ace/MEM_Stream.h +++ b/ACE/ace/MEM_Stream.h @@ -81,10 +81,10 @@ public: #if 0 /** - * Try to send exactly bytes into from (uses + * Try to send exactly @a len bytes into @a buf from (uses * the call). If blocks for longer than @a timeout the * number of bytes actually sent is returned with . - * If a timeout does not occur, return (i.e., the + * If a timeout does not occur, return @a len (i.e., the * number of bytes requested to be sent). */ ssize_t send_n (const void *buf, @@ -93,14 +93,14 @@ public: const ACE_Time_Value *timeout); /** - * Try to recv exactly bytes into from (uses + * Try to recv exactly @a len bytes into @a buf from (uses * the 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 *@a timeout elapses). If blocks * for longer than @a timeout the number of bytes actually read is * returned with . If a timeout does not occur, - * return (i.e., the number of bytes requested to be + * return @a len (i.e., the number of bytes requested to be * read). */ ssize_t recv_n (void *buf, @@ -109,14 +109,14 @@ public: const ACE_Time_Value *timeout); /** - * Send an of size to the connected socket (uses + * Send an of size @a n to the connected socket (uses * ). Will block until all bytes are sent or an error * occurs. */ ssize_t sendv_n (const iovec iov[], size_t n) const; - /// Receive an of size to the connected socket. + /// Receive an of size @a n to the connected socket. ssize_t recvv_n (iovec iov[], size_t n) const; #endif /* 0 */ diff --git a/ACE/ace/MMAP_Memory_Pool.h b/ACE/ace/MMAP_Memory_Pool.h index 5b9cc3f3186..aac103f1728 100644 --- a/ACE/ace/MMAP_Memory_Pool.h +++ b/ACE/ace/MMAP_Memory_Pool.h @@ -166,15 +166,15 @@ public: /// Sync the memory region to the backing store starting at /// @c this->base_addr_. Will sync as much as the backing file - /// allows. + /// allows. virtual int sync (int flags = MS_SYNC); - + /// Sync the memory region to the backing store starting at @a addr. virtual int sync (void *addr, size_t len, int flags = MS_SYNC); /** * Change the protection of the pages of the mapped region to - * starting at base_addr_> up to bytes. If == -1 + * starting at base_addr_> up to @a len bytes. If @a len == -1 * then change protection of all pages in the mapped region. */ virtual int protect (size_t len, int prot = PROT_RDWR); diff --git a/ACE/ace/Malloc_Base.h b/ACE/ace/Malloc_Base.h index 0104acdda4b..eb992bdd26a 100644 --- a/ACE/ace/Malloc_Base.h +++ b/ACE/ace/Malloc_Base.h @@ -135,13 +135,13 @@ public: /** * Change the protection of the pages of the mapped region to - * starting at base_addr_> up to bytes. If == -1 + * starting at base_addr_> up to @a len bytes. If @a len == -1 * then change protection of all pages in the mapped region. */ virtual int protect (ssize_t len = -1, int prot = PROT_RDWR) = 0; /// Change the protection of the pages of the mapped region to - /// starting at up to bytes. + /// starting at up to @a len bytes. virtual int protect (void *addr, size_type len, int prot = PROT_RDWR) = 0; #if defined (ACE_HAS_MALLOC_STATS) diff --git a/ACE/ace/Mem_Map.h b/ACE/ace/Mem_Map.h index 847568fb53e..157ecf796ac 100644 --- a/ACE/ace/Mem_Map.h +++ b/ACE/ace/Mem_Map.h @@ -135,8 +135,8 @@ public: int unmap (void *addr, ssize_t len); /** - * Sync bytes of the memory region to the backing store - * starting at . If == -1 then sync the whole + * Sync @a len bytes of the memory region to the backing store + * starting at . If @a len == -1 then sync the whole * region. */ int sync (size_t len, int flags = MS_SYNC); @@ -147,13 +147,13 @@ public: */ int sync (int flags = MS_SYNC); - /// Sync bytes of the memory region to the backing store + /// Sync @a len bytes of the memory region to the backing store /// starting at . int sync (void *addr, size_t len, int flags = MS_SYNC); /** * Change the protection of the pages of the mapped region to - * starting at up to bytes. + * starting at up to @a len bytes. */ int protect (size_t len, int prot = PROT_RDWR); @@ -164,7 +164,7 @@ public: int protect (int prot = PROT_RDWR); /// Change the protection of the pages of the mapped region to - /// starting at up to bytes. + /// starting at up to @a len bytes. int protect (void *addr, size_t len, int prot = PROT_RDWR); /// Close and remove the file from the file system. diff --git a/ACE/ace/Message_Block.h b/ACE/ace/Message_Block.h index 1f5c9d1971e..db52a13bb94 100644 --- a/ACE/ace/Message_Block.h +++ b/ACE/ace/Message_Block.h @@ -468,7 +468,7 @@ public: /// Set the write pointer to @a ptr. void wr_ptr (char *ptr); - /// Set the write pointer ahead bytes. This is used to compute + /// Set the write pointer ahead @a n bytes. This is used to compute /// the of a message. void wr_ptr (size_t n); diff --git a/ACE/ace/OS_NS_unistd.h b/ACE/ace/OS_NS_unistd.h index f076594de80..9df370a1c1c 100644 --- a/ACE/ace/OS_NS_unistd.h +++ b/ACE/ace/OS_NS_unistd.h @@ -245,7 +245,7 @@ namespace ACE_OS ACE_OVERLAPPED *); /** - * Receive bytes into from (uses the + * Receive @a len bytes into @a buf from (uses the * call, which uses the system call on UNIX * and the call on Win32). If errors occur, -1 is * returned. If EOF occurs, 0 is returned. Whatever data has been @@ -346,7 +346,7 @@ namespace ACE_OS ACE_OVERLAPPED *); /** - * Send bytes from to (uses the + * Send @a len bytes from @a buf to (uses the * calls, which is uses the system call on UNIX and the * call on Win32). If errors occur, -1 is returned. If * EOF occurs, 0 is returned. Whatever data has been transmitted diff --git a/ACE/ace/Pipe.h b/ACE/ace/Pipe.h index 1c88ccdc3ed..7e1a891dddf 100644 --- a/ACE/ace/Pipe.h +++ b/ACE/ace/Pipe.h @@ -85,10 +85,10 @@ public: /// Dump the state of the object. void dump (void) const; - /// send upto bytes in . + /// send upto @a n bytes in @a buf. ssize_t send (const void *buf, size_t n) const; - /// Recv upto bytes in . + /// Recv upto @a n bytes in @a buf. ssize_t recv (void *buf, size_t n) const; /// Send n bytes, keep trying until n are sent. @@ -127,26 +127,26 @@ public: */ ssize_t recv (size_t n, ...) const; - /// Send bytes via Win32 WriteFile using overlapped I/O. + /// Send @a n bytes via Win32 WriteFile using overlapped I/O. ssize_t send (const void *buf, size_t n, ACE_OVERLAPPED *overlapped) const; - /// Recv bytes via Win32 ReadFile using overlapped I/O. + /// Recv @a n bytes via Win32 ReadFile using overlapped I/O. ssize_t recv (void *buf, size_t n, ACE_OVERLAPPED *overlapped) const; - /// Send an of size to the file. + /// Send an of size @a n to the file. ssize_t sendv (const iovec iov[], int n) const; - /// Send an of size to the file. Will block until all + /// Send an of size @a n to the file. Will block until all /// bytes are sent or an error occurs. ssize_t sendv_n (const iovec iov[], int n) const; - /// Receive an of size to the file. + /// Receive an of size @a n to the file. ssize_t recvv_n (iovec iov[], int n) const; diff --git a/ACE/ace/Process_Manager.h b/ACE/ace/Process_Manager.h index 806d5ecd438..38026a85fe9 100644 --- a/ACE/ace/Process_Manager.h +++ b/ACE/ace/Process_Manager.h @@ -202,7 +202,7 @@ public: /** * Create @a n new processes by passing @a options to * , which is called @a n times. If - * is non-0 it is expected to be an array of 's, which + * is non-0 it is expected to be an array of @a n 's, which * are filled in with the process ids of each newly created process. * Register @a event_handler to be called back when each process exits. * Returns 0 on success and -1 on failure. diff --git a/ACE/ace/QoS/SOCK_Dgram_Mcast_QoS.h b/ACE/ace/QoS/SOCK_Dgram_Mcast_QoS.h index af799d2d0d8..1bb5f873a8c 100644 --- a/ACE/ace/QoS/SOCK_Dgram_Mcast_QoS.h +++ b/ACE/ace/QoS/SOCK_Dgram_Mcast_QoS.h @@ -91,7 +91,7 @@ public: ACE_OVERLAPPED *overlapped, ACE_OVERLAPPED_COMPLETION_FUNC func) const; - /// Send an byte to the datagram socket (uses ). + /// Send an @a n byte @a buf to the datagram socket (uses ). ssize_t send (const void *buf, size_t n, const ACE_Addr &addr, diff --git a/ACE/ace/SOCK_Dgram.h b/ACE/ace/SOCK_Dgram.h index dc45f8c5c27..23dc687eba1 100644 --- a/ACE/ace/SOCK_Dgram.h +++ b/ACE/ace/SOCK_Dgram.h @@ -84,13 +84,13 @@ public: ~ACE_SOCK_Dgram (void); // = Data transfer routines. - /// Send an byte to the datagram socket (uses ). + /// Send an @a n byte @a buf to the datagram socket (uses ). ssize_t send (const void *buf, size_t n, const ACE_Addr &addr, int flags = 0) const; - /// Receive an byte from the datagram socket (uses + /// Receive an @a n byte @a buf from the datagram socket (uses /// ). ssize_t recv (void *buf, size_t n, @@ -110,14 +110,14 @@ public: int flags = 0, const ACE_Time_Value *timeout = 0) const; - /// Send an of size to the datagram socket (uses + /// Send an of size @a n to the datagram socket (uses /// ). ssize_t send (const iovec iov[], int n, const ACE_Addr &addr, int flags = 0) const; - /// Recv an of size to the datagram socket (uses + /// Recv an of size @a n to the datagram socket (uses /// ). ssize_t recv (iovec iov[], int n, @@ -126,7 +126,7 @@ public: /** * Wait up to @a timeout amount of time to receive a datagram into - * . The ACE_Time_Value indicates how long to blocking + * @a 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 *@a timeout elapses). If times out a -1 is @@ -141,7 +141,7 @@ public: /** * Wait up to @a timeout amount of time to send a datagram to - * . The ACE_Time_Value indicates how long to blocking + * @a 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 *@a timeout elapses). If times out a -1 is @@ -174,7 +174,7 @@ public: ACE_OVERLAPPED *overlapped, ACE_OVERLAPPED_COMPLETION_FUNC func) const; - /// Send an byte to the datagram socket (uses ). + /// Send an @a n byte @a buf to the datagram socket (uses ). ssize_t send (const void *buf, size_t n, const ACE_Addr &addr, @@ -182,7 +182,7 @@ public: ACE_OVERLAPPED *overlapped, ACE_OVERLAPPED_COMPLETION_FUNC func) const; - /// Receive an byte from the datagram socket (uses + /// Receive an @a n byte @a buf from the datagram socket (uses /// ). ssize_t recv (void *buf, size_t n, diff --git a/ACE/ace/SOCK_Dgram_Mcast.h b/ACE/ace/SOCK_Dgram_Mcast.h index 5acb52076fe..2fa166ae097 100644 --- a/ACE/ace/SOCK_Dgram_Mcast.h +++ b/ACE/ace/SOCK_Dgram_Mcast.h @@ -312,13 +312,13 @@ public: // = Data transfer routines. - /// Send bytes in , using the multicast address and network interface + /// Send @a n bytes in @a buf, using the multicast address and network interface /// defined by the first or . ssize_t send (const void *buf, size_t n, int flags = 0) const; - /// Send , using the multicast address and network interface + /// Send @a n , using the multicast address and network interface /// defined by the first or . ssize_t send (const iovec iov[], int n, diff --git a/ACE/ace/SOCK_IO.h b/ACE/ace/SOCK_IO.h index 1da5908b03e..4d6d9d22183 100644 --- a/ACE/ace/SOCK_IO.h +++ b/ACE/ace/SOCK_IO.h @@ -58,18 +58,18 @@ public: /// Destructor. ~ACE_SOCK_IO (void); - /// Recv an byte buffer from the connected socket. + /// Recv an @a n byte buffer from the connected socket. ssize_t recv (void *buf, size_t n, int flags, const ACE_Time_Value *timeout = 0) const; - /// Recv an byte buffer from the connected socket. + /// Recv an @a n byte buffer from the connected socket. ssize_t recv (void *buf, size_t n, const ACE_Time_Value *timeout = 0) const; - /// Recv an of size from the connected socket. + /// Recv an of size @a n from the connected socket. ssize_t recvv (iovec iov[], int n, const ACE_Time_Value *timeout = 0) const; @@ -85,36 +85,36 @@ public: ssize_t recvv (iovec *io_vec, const ACE_Time_Value *timeout = 0) const; - /// Recv varargs messages to the connected socket. + /// Recv @a n varargs messages to the connected socket. ssize_t recv (size_t n, ...) const; - /// Recv bytes via Win32 using overlapped I/O. + /// Recv @a n bytes via Win32 using overlapped I/O. ssize_t recv (void *buf, size_t n, ACE_OVERLAPPED *overlapped) const; - /// Send an byte buffer to the connected socket. + /// Send an @a n byte buffer to the connected socket. ssize_t send (const void *buf, size_t n, int flags, const ACE_Time_Value *timeout = 0) const; - /// Send an byte buffer to the connected socket. + /// Send an @a n byte buffer to the connected socket. ssize_t send (const void *buf, size_t n, const ACE_Time_Value *timeout = 0) const; - /// Send an of size to the connected socket. + /// Send an of size @a n to the connected socket. ssize_t sendv (const iovec iov[], int n, const ACE_Time_Value *timeout = 0) const; - /// Send varargs messages to the connected socket. + /// Send @a n varargs messages to the connected socket. ssize_t send (size_t n, ...) const; - /// Send bytes via Win32 using overlapped I/O. + /// Send @a n bytes via Win32 using overlapped I/O. ssize_t send (const void *buf, size_t n, ACE_OVERLAPPED *overlapped) const; diff --git a/ACE/ace/SOCK_SEQPACK_Association.h b/ACE/ace/SOCK_SEQPACK_Association.h index d559a2e2009..be668d4461d 100644 --- a/ACE/ace/SOCK_SEQPACK_Association.h +++ b/ACE/ace/SOCK_SEQPACK_Association.h @@ -42,8 +42,8 @@ class ACE_Message_Block; * This adds additional wrapper methods atop the * class. * - * is the buffer to write from or receive into. - * is the number of bytes to transfer. + * @a buf is the buffer to write from or receive into. + * @a len is the number of bytes to transfer. * 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 @@ -108,14 +108,14 @@ public: // = I/O functions. - /// Try to recv exactly bytes into from the connected socket. + /// Try to recv exactly @a len bytes into @a buf from the connected socket. ssize_t recv_n (void *buf, size_t len, int flags, const ACE_Time_Value *timeout = 0, size_t *bytes_transferred = 0) const; - /// Try to recv exactly bytes into from the connected socket. + /// Try to recv exactly @a len bytes into @a buf from the connected socket. ssize_t recv_n (void *buf, size_t len, const ACE_Time_Value *timeout = 0, @@ -127,14 +127,14 @@ public: const ACE_Time_Value *timeout = 0, size_t *bytes_transferred = 0) const; - /// Try to send exactly bytes from to the connection socket. + /// Try to send exactly @a len bytes from @a buf to the connection socket. ssize_t send_n (const void *buf, size_t len, int flags, const ACE_Time_Value *timeout = 0, size_t *bytes_transferred = 0) const; - /// Try to send exactly bytes from to the connected socket. + /// Try to send exactly @a len bytes from @a buf to the connected socket. ssize_t send_n (const void *buf, size_t len, const ACE_Time_Value *timeout = 0, diff --git a/ACE/ace/SPIPE_Stream.h b/ACE/ace/SPIPE_Stream.h index 9a94216ae40..7e4c90735f4 100644 --- a/ACE/ace/SPIPE_Stream.h +++ b/ACE/ace/SPIPE_Stream.h @@ -31,8 +31,8 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL * * @brief Defines the methods in the abstraction. * - * is the buffer to write from or receive into. - * is the number of bytes to transfer. + * @a buf is the buffer to write from or receive into. + * @a len is the number of bytes to transfer. * * The "_n()" I/O methods keep looping until all the data has been * transferred. These methods also work for sockets in non-blocking @@ -72,10 +72,10 @@ public: /// Recv an open FD from another process. int recv_handle (strrecvfd &recvfd) const; - /// Send bytes, keep trying until are sent. + /// Send @a len bytes, keep trying until @a len are sent. ssize_t send_n (const void *buf, size_t len) const; - /// Recv bytes, keep trying until are received. + /// Recv @a len bytes, keep trying until @a len are received. ssize_t recv_n (void *buf, size_t len) const; /// Send bytes via STREAM pipes using "band" mode. @@ -129,22 +129,22 @@ public: */ ssize_t recv (size_t len, ...) const; - /// Send bytes via Win32 using overlapped I/O. + /// Send @a len bytes via Win32 using overlapped I/O. ssize_t send (const void *buf, size_t len, ACE_OVERLAPPED *overlapped) const; - /// Recv bytes via Win32 using overlapped I/O. + /// Recv @a len bytes via Win32 using overlapped I/O. ssize_t recv (void *buf, size_t len, ACE_OVERLAPPED *overlapped) const; - /// Send an of size to the stream. + /// Send an of size @a len to the stream. ssize_t sendv (const iovec iov[], int len) const; - /// Send an of size to the stream. Will block until all + /// Send an of size @a len to the stream. Will block until all /// bytes are sent or an error occurs. ssize_t sendv_n (const iovec iov[], int len) const; - /// Receive an of size to the stream. + /// Receive an of size @a len to the stream. ssize_t recvv_n (iovec iov[], int len) const; diff --git a/ACE/ace/Service_Types.h b/ACE/ace/Service_Types.h index 8f7e838f4e3..5888be064e8 100644 --- a/ACE/ace/Service_Types.h +++ b/ACE/ace/Service_Types.h @@ -122,7 +122,7 @@ class ACE_Export ACE_Module_Type : public ACE_Service_Type_Impl { public: // = Initialization method. - ACE_Module_Type (void *m, // Really an *. + ACE_Module_Type (void *m, // Really an ACE_Module *. const ACE_TCHAR *identifier, u_int flags = 0); diff --git a/ACE/ace/Shared_Memory_Pool.h b/ACE/ace/Shared_Memory_Pool.h index a54ef63da58..dfc5786b57f 100644 --- a/ACE/ace/Shared_Memory_Pool.h +++ b/ACE/ace/Shared_Memory_Pool.h @@ -122,7 +122,7 @@ public: virtual int protect (ssize_t len = -1, int prot = PROT_RDWR); /// Change the protection of the pages of the mapped region to - /// starting at up to bytes. + /// starting at up to @a len bytes. virtual int protect (void *addr, size_t len, int prot = PROT_RDWR); /// Return the base address of this memory pool, 0 if base_addr diff --git a/ACE/ace/Stream.h b/ACE/ace/Stream.h index 59b440d02d0..b51e3c23880 100644 --- a/ACE/ace/Stream.h +++ b/ACE/ace/Stream.h @@ -88,12 +88,12 @@ public: // = ACE_Stream plumbing operations /// Add a new module right below the Stream head. The - /// hook methods of the in this + /// hook methods of the in this ACE_Module /// are invoked to initialize the tasks. virtual int push (ACE_Module *mod); /// Remove the right below the Stream head and close it down. - // The hook methods of the in this + // The hook methods of the in this ACE_Module /// are invoked to cleanup the tasks. virtual int pop (int flags = M_DELETE); diff --git a/ACE/ace/Task.h b/ACE/ace/Task.h index 8f5336f536e..be7272e246a 100644 --- a/ACE/ace/Task.h +++ b/ACE/ace/Task.h @@ -60,7 +60,7 @@ namespace ACE_Task_Flags * * This class factors out the non-template code in order to * reduce template bloat, as well as to make it possible for the - * to store *'s + * to store ACE_Task_Base *'s * polymorphically. */ class ACE_Export ACE_Task_Base : public ACE_Service_Object @@ -154,7 +154,7 @@ public: * EXTREMEMLY implementation-dependent, and are probably best * avoided. * - * If != 0 it is assumed to be an array of + * If != 0 it is assumed to be an array of @a n * thread_handles that will be assigned the values of the thread * handles being spawned. Returns -1 on failure ( will * explain...), otherwise returns the group id of the threads. @@ -168,10 +168,10 @@ public: * specified value must therefore be manipulated thru * ACE_Thread_Manager directly. * - * If != 0 it is assumed to be an array of pointers to + * If != 0 it is assumed to be an array of @a n pointers to * the base of the stacks to use for the threads being spawned. * Likewise, if != 0 it is assumed to be an array of - * values indicating how big each of the corresponding s + * @a n values indicating how big each of the corresponding s * are. * * diff --git a/ACE/ace/Thread.h b/ACE/ace/Thread.h index 6a22fb34ee6..ceb6fc9c1fd 100644 --- a/ACE/ace/Thread.h +++ b/ACE/ace/Thread.h @@ -115,16 +115,16 @@ public: ACE_Thread_Adapter *thread_adapter = 0); /** - * Spawn new threads, which execute with argument + * Spawn @a n new threads, which execute with argument * (if is non-0 then and are ignored * and are obtained from ). The thread_ids of * successfully spawned threads will be placed into the - * buffer (which must be the same size as ). If != 0 it - * is assumed to be an array of pointers to the base of the + * buffer (which must be the same size as @a n). If != 0 it + * is assumed to be an array of @a n pointers to the base of the * stacks to use for the threads being spawned. If != - * 0 it is assumed to be an array of values indicating how big + * 0 it is assumed to be an array of @a n values indicating how big * each of the corresponding s are. If != 0 - * it is assumed to be an array of thread_handles that will be + * it is assumed to be an array of @a n thread_handles that will be * assigned the values of the thread handles being spawned. Returns * the number of threads actually spawned (if this doesn't equal the * number requested then something has gone wrong and will diff --git a/ACE/ace/Thread_Manager.h b/ACE/ace/Thread_Manager.h index c2b2c6dc1d9..35a09641250 100644 --- a/ACE/ace/Thread_Manager.h +++ b/ACE/ace/Thread_Manager.h @@ -190,8 +190,8 @@ public: /// Current state of the thread. ACE_UINT32 state (void) const; - /// Return the pointer to an or NULL if there's no - /// associated with this thread.; + /// Return the pointer to an ACE_Task_Base or NULL if there's no + /// ACE_Task_Base associated with this thread.; ACE_Task_Base *task (void) const; protected: @@ -210,8 +210,8 @@ protected: /// Current state of the thread. ACE_UINT32 thr_state_; - /// Pointer to an or NULL if there's no - /// . + /// Pointer to an ACE_Task_Base or NULL if there's no + /// ACE_Task_Base. ACE_Task_Base *task_; /// We need these pointers to maintain the double-linked list in a @@ -494,12 +494,12 @@ public: * Spawn N new threads, which execute with argument . * If != 0 the thread_ids of successfully spawned * threads will be placed into the buffer (which must - * be the same size as ). If != 0 it is assumed to be an - * array of pointers to the base of the stacks to use for the + * be the same size as @a n). If != 0 it is assumed to be an + * array of @a n pointers to the base of the stacks to use for the * threads being spawned. If != 0 it is assumed to be - * an array of values indicating how big each of the + * an array of @a n values indicating how big each of the * corresponding s are. If != 0 it is - * assumed to be an array of thread_handles that will be + * assumed to be an array of @a n thread_handles that will be * assigned the values of the thread handles being spawned. * * Threads in Thread_Manager can be manipulated in groups based on @@ -507,7 +507,7 @@ public: * cancel_task(). * * If is assigned, the newly spawned threads are added into - * the group. Otherwise, the Thread_Manager assigns these + * the group. Otherwise, the Thread_Manager assigns these @a n * threads with a grp_id. You should choose either assigning * everytime, or let the Thread_Manager handles it for * you consistently. @@ -534,12 +534,12 @@ public: * Spawn N new threads, which execute with argument . * If != 0 the thread_ids of successfully spawned * threads will be placed into the buffer (which must - * be the same size as ). If != 0 it is assumed to be an - * array of pointers to the base of the stacks to use for the + * be the same size as @a n). If != 0 it is assumed to be an + * array of @a n pointers to the base of the stacks to use for the * threads being spawned. If != 0 it is assumed to be - * an array of values indicating how big each of the + * an array of @a n values indicating how big each of the * corresponding s are. If != 0 it is - * assumed to be an array of thread_handles that will be + * assumed to be an array of @a n thread_handles that will be * assigned the values of the thread handles being spawned. * * Threads in Thread_Manager can be manipulated in groups based on @@ -547,7 +547,7 @@ public: * cancel_task(). * * If is assigned, the newly spawned threads are added into - * the group. Otherwise, the Thread_Manager assigns these + * the group. Otherwise, the Thread_Manager assigns these @a n * threads with a grp_id. You should choose either assigning * everytime, or let the Thread_Manager handles it for * you consistently. @@ -648,8 +648,8 @@ public: ACE_thread_t thr_self (void); /** - * Returns a pointer to the current we're executing - * in if this thread is indeed running in an , else + * Returns a pointer to the current ACE_Task_Base we're executing + * in if this thread is indeed running in an ACE_Task_Base, else * return 0. */ ACE_Task_Base *task (void); @@ -791,10 +791,10 @@ public: int hthread_within (ACE_hthread_t handle); int thread_within (ACE_thread_t tid); - /// Returns the number of in a group. + /// Returns the number of ACE_Task_Base in a group. int num_tasks_in_group (int grp_id); - /// Returns the number of threads in an . + /// Returns the number of threads in an ACE_Task_Base. int num_threads_in_task (ACE_Task_Base *task); /** @@ -825,9 +825,9 @@ public: size_t n); /** - * Returns in a list of up to thread ids in an - * . The caller must allocate the memory for - * . In case of an error, -1 is returned. If no + * Returns in @a thread_list a list of up to @a n thread ids in an + * ACE_Task_Base. The caller must allocate the memory for + * @a thread_list. In case of an error, -1 is returned. If no * requested values are found, 0 is returned, otherwise correct * number of retrieved values are returned. */ @@ -836,8 +836,8 @@ public: size_t n); /** - * Returns in a list of up to thread handles in - * an . The caller must allocate memory for + * Returns in a list of up to @a n thread handles in + * an ACE_Task_Base. The caller must allocate memory for * . In case of an error, -1 is returned. If no * requested values are found, 0 is returned, otherwise correct * number of retrieved values are returned. @@ -847,9 +847,9 @@ public: size_t n); /** - * Returns in a list of up to thread ids in a + * Returns in @a thread_list a list of up to @a n thread ids in a * group . The caller must allocate the memory for - * . In case of an error, -1 is returned. If no + * @a thread_list. In case of an error, -1 is returned. If no * requested values are found, 0 is returned, otherwise correct * number of retrieved values are returned. */ @@ -858,7 +858,7 @@ public: size_t n); /** - * Returns in a list of up to thread handles in + * Returns in a list of up to @a n thread handles in * a group . The caller must allocate memory for * . */ @@ -891,8 +891,8 @@ public: size_t n); /** - * Returns in a list of up to thread ids. The - * caller must allocate the memory for . In case of an + * Returns in @a thread_list a list of up to @a n thread ids. The + * caller must allocate the memory for @a thread_list. In case of an * error, -1 is returned. If no requested values are found, 0 is * returned, otherwise correct number of retrieved values are * returned. diff --git a/ACE/ace/UPIPE_Stream.h b/ACE/ace/UPIPE_Stream.h index 98e31cf3349..e43a1eb4330 100644 --- a/ACE/ace/UPIPE_Stream.h +++ b/ACE/ace/UPIPE_Stream.h @@ -85,7 +85,7 @@ public: size_t n, ACE_Time_Value *timeout = 0); - /// Recv a buffer of exactly bytes from the message queue. + /// Recv a buffer of exactly @a n bytes from the message queue. /// Returns -1 on error, else the number of bytes read. ssize_t recv_n (char *buffer, size_t n, -- cgit v1.2.1