From 8f778c8bcb1354dffbf1abf96d5872a75304c02f Mon Sep 17 00:00:00 2001 From: Johnny Willemsen Date: Wed, 23 May 2007 13:33:56 +0000 Subject: Wed May 23 15:32:55 UTC 2007 Johnny Willemsen --- ACE/ChangeLog | 62 ++++++++++++++++++++++++++++++++++++++ ACE/ace/Active_Map_Manager_T.h | 2 +- ACE/ace/Asynch_IO_Impl.h | 2 +- ACE/ace/Bound_Ptr.h | 20 ++++++------ ACE/ace/Cache_Map_Manager_T.h | 4 +-- ACE/ace/Dump_T.h | 2 +- ACE/ace/File_Lock.h | 12 ++++---- ACE/ace/Framework_Component.h | 2 +- ACE/ace/Hash_Map_Manager_T.h | 12 ++++---- ACE/ace/IOStream_T.h | 2 +- ACE/ace/Lock.h | 6 ++-- ACE/ace/Malloc_Allocator.h | 2 +- ACE/ace/Map_Manager.h | 6 ++-- ACE/ace/Map_T.h | 8 ++--- ACE/ace/Message_Block.h | 2 +- ACE/ace/Message_Queue.h | 20 ++++++------ ACE/ace/Message_Queue_T.h | 4 +-- ACE/ace/Name_Request_Reply.h | 2 +- ACE/ace/Node.h | 2 +- ACE/ace/Null_Condition.h | 4 +-- ACE/ace/Null_Mutex.h | 4 +-- ACE/ace/Null_Semaphore.h | 4 +-- ACE/ace/OS_Errno.h | 4 +-- ACE/ace/OS_NS_Thread.h | 2 +- ACE/ace/OS_NS_errno.h | 2 +- ACE/ace/POSIX_Asynch_IO.h | 2 +- ACE/ace/Process_Mutex.h | 4 +-- ACE/ace/Process_Semaphore.h | 4 +-- ACE/ace/RB_Tree.h | 2 +- ACE/ace/RW_Mutex.h | 8 ++--- ACE/ace/RW_Process_Mutex.h | 6 ++-- ACE/ace/RW_Thread_Mutex.h | 2 +- ACE/ace/Recursive_Thread_Mutex.h | 14 ++++----- ACE/ace/Refcounted_Auto_Ptr.h | 2 +- ACE/ace/Registry.h | 36 +++++++++++----------- ACE/ace/Remote_Tokens.h | 4 +-- ACE/ace/SOCK.h | 2 +- ACE/ace/SOCK_Acceptor.h | 14 ++++----- ACE/ace/SOCK_SEQPACK_Acceptor.h | 10 +++--- ACE/ace/SOCK_SEQPACK_Association.h | 2 +- ACE/ace/SString.h | 2 +- ACE/ace/Semaphore.h | 12 ++++---- ACE/ace/Service_Types.h | 2 +- ACE/ace/Signal.h | 2 +- ACE/ace/Stream.h | 4 +-- ACE/ace/Task.h | 8 ++--- ACE/ace/Thread.h | 4 +-- ACE/ace/Thread_Adapter.h | 2 +- ACE/ace/Thread_Exit.h | 4 +-- ACE/ace/Thread_Manager.h | 24 +++++++-------- ACE/ace/Thread_Mutex.h | 10 +++--- ACE/ace/Timer_Hash_T.h | 2 +- ACE/ace/Timer_Heap_T.h | 12 ++++---- ACE/ace/Timer_Queue_T.h | 2 +- ACE/ace/Token_Collection.h | 8 ++--- ACE/ace/Token_Request_Reply.h | 4 +-- ACE/ace/Unbounded_Set.h | 4 +-- ACE/ace/WIN32_Asynch_IO.h | 18 +++++------ ACE/ace/config-lite.h | 2 +- 59 files changed, 246 insertions(+), 184 deletions(-) diff --git a/ACE/ChangeLog b/ACE/ChangeLog index c794db695f2..36966dd62cd 100644 --- a/ACE/ChangeLog +++ b/ACE/ChangeLog @@ -1,3 +1,65 @@ +Wed May 23 15:32:55 UTC 2007 Johnny Willemsen + + * ace/Active_Map_Manager_T.h: + * ace/Asynch_IO_Impl.h: + * ace/Bound_Ptr.h: + * ace/Cache_Map_Manager_T.h: + * ace/config-lite.h: + * ace/Dump_T.h: + * ace/File_Lock.h: + * ace/Framework_Component.h: + * ace/Hash_Map_Manager_T.h: + * ace/IOStream_T.h: + * ace/Lock.h: + * ace/Malloc_Allocator.h: + * ace/Map_Manager.h: + * ace/Map_T.h: + * ace/Message_Block.h: + * ace/Message_Queue.h: + * ace/Message_Queue_T.h: + * ace/Name_Request_Reply.h: + * ace/Node.h: + * ace/Null_Condition.h: + * ace/Null_Mutex.h: + * ace/Null_Semaphore.h: + * ace/OS_Errno.h: + * ace/OS_NS_errno.h: + * ace/OS_NS_Thread.h: + * ace/POSIX_Asynch_IO.h: + * ace/Process_Mutex.h: + * ace/Process_Semaphore.h: + * ace/RB_Tree.h: + * ace/Recursive_Thread_Mutex.h: + * ace/Refcounted_Auto_Ptr.h: + * ace/Registry.h: + * ace/Remote_Tokens.h: + * ace/RW_Mutex.h: + * ace/RW_Process_Mutex.h: + * ace/RW_Thread_Mutex.h: + * ace/Semaphore.h: + * ace/Service_Types.h: + * ace/Signal.h: + * ace/SOCK.h: + * ace/SOCK_Acceptor.h: + * ace/SOCK_SEQPACK_Acceptor.h: + * ace/SOCK_SEQPACK_Association.h: + * ace/SString.h: + * ace/Stream.h: + * ace/Task.h: + * ace/Thread.h: + * ace/Thread_Adapter.h: + * ace/Thread_Exit.h: + * ace/Thread_Manager.h: + * ace/Thread_Mutex.h: + * ace/Timer_Hash_T.h: + * ace/Timer_Heap_T.h: + * ace/Timer_Queue_T.h: + * ace/Token_Collection.h: + * ace/Token_Request_Reply.h: + * ace/Unbounded_Set.h: + * ace/WIN32_Asynch_IO.h: + Fixed some doxygen warnings + Wed May 23 13:19:55 UTC 2007 Johnny Willemsen * tests/Process_Manager_Test.cpp: diff --git a/ACE/ace/Active_Map_Manager_T.h b/ACE/ace/Active_Map_Manager_T.h index ddec2d1f9bc..34b5a475652 100644 --- a/ACE/ace/Active_Map_Manager_T.h +++ b/ACE/ace/Active_Map_Manager_T.h @@ -53,7 +53,7 @@ public: typedef REVERSE_ITERATOR reverse_iterator; // = Initialization and termination methods. - /// Initialize a with the . + /// Initialize a with the ACE_DEFAULT_MAP_SIZE. ACE_Active_Map_Manager (ACE_Allocator *alloc = 0); /// Initialize a with @a size entries. diff --git a/ACE/ace/Asynch_IO_Impl.h b/ACE/ace/Asynch_IO_Impl.h index b1af7a57d25..e6aa77be56c 100644 --- a/ACE/ace/Asynch_IO_Impl.h +++ b/ACE/ace/Asynch_IO_Impl.h @@ -97,7 +97,7 @@ public: const void *completion_key, u_long error = 0) = 0; - /// Post to the Proactor's completion port. + /// Post @c this to the Proactor's completion port. virtual int post_completion (ACE_Proactor_Impl *proactor) = 0; protected: diff --git a/ACE/ace/Bound_Ptr.h b/ACE/ace/Bound_Ptr.h index 07b54f69962..7d54e6f1966 100644 --- a/ACE/ace/Bound_Ptr.h +++ b/ACE/ace/Bound_Ptr.h @@ -120,13 +120,13 @@ public: /// ownership of an object from an auto_ptr. explicit ACE_Strong_Bound_Ptr (auto_ptr p); - /// Copy constructor binds and to the same object. + /// Copy constructor binds @c this and @a r to the same object. ACE_Strong_Bound_Ptr (const ACE_Strong_Bound_Ptr &r); - /// Constructor binds and to the same object. + /// Constructor binds @c this and @a r to the same object. ACE_Strong_Bound_Ptr (const ACE_Weak_Bound_Ptr &r); - /// Copy constructor binds and to the same object if + /// Copy constructor binds @c this and @a r to the same object if /// Y* can be implicitly converted to X*. template ACE_Strong_Bound_Ptr (const ACE_Strong_Bound_Ptr &r) @@ -142,13 +142,13 @@ public: /// Destructor. ~ACE_Strong_Bound_Ptr (void); - /// Assignment operator that binds and to the same object. + /// Assignment operator that binds @c this and @a r to the same object. void operator = (const ACE_Strong_Bound_Ptr &r); - /// Assignment operator that binds and to the same object. + /// Assignment operator that binds @c this and @a r to the same object. void operator = (const ACE_Weak_Bound_Ptr &r); - /// Assignment operator that binds and to the same object + /// Assignment operator that binds @c this and @a r to the same object /// if Y* can be implicitly converted to X*. template ACE_Weak_Bound_Ptr& @@ -270,19 +270,19 @@ public: /// the object \ immediately. explicit ACE_Weak_Bound_Ptr (X *p = 0); - /// Copy constructor binds and to the same object. + /// Copy constructor binds @c this and @a r to the same object. ACE_Weak_Bound_Ptr (const ACE_Weak_Bound_Ptr &r); - /// Constructor binds and to the same object. + /// Constructor binds @c this and @a r to the same object. ACE_Weak_Bound_Ptr (const ACE_Strong_Bound_Ptr &r); /// Destructor. ~ACE_Weak_Bound_Ptr (void); - /// Assignment operator that binds and to the same object. + /// Assignment operator that binds @c this and @a r to the same object. void operator = (const ACE_Weak_Bound_Ptr &r); - /// Assignment operator that binds and to the same object. + /// Assignment operator that binds @c this and @a r to the same object. void operator = (const ACE_Strong_Bound_Ptr &r); /// Equality operator that returns @c true if both diff --git a/ACE/ace/Cache_Map_Manager_T.h b/ACE/ace/Cache_Map_Manager_T.h index c75e602fb25..0c533f7a0ae 100644 --- a/ACE/ace/Cache_Map_Manager_T.h +++ b/ACE/ace/Cache_Map_Manager_T.h @@ -278,7 +278,7 @@ public: bool operator== (const ACE_Cache_Map_Iterator &rhs) const; bool operator!= (const ACE_Cache_Map_Iterator &rhs) const; - /// Returns a reference to the internal element is pointing + /// Returns a reference to the internal element @c this is pointing /// to. ACE_Reference_Pair operator* (void) const; @@ -352,7 +352,7 @@ public: bool operator== (const ACE_Cache_Map_Reverse_Iterator &rhs) const; bool operator!= (const ACE_Cache_Map_Reverse_Iterator &rhs) const; - /// Returns a reference to the internal element is pointing + /// Returns a reference to the internal element @c this is pointing /// to. ACE_Reference_Pair operator* (void) const; diff --git a/ACE/ace/Dump_T.h b/ACE/ace/Dump_T.h index 561569765a4..33249fb1fa9 100644 --- a/ACE/ace/Dump_T.h +++ b/ACE/ace/Dump_T.h @@ -51,7 +51,7 @@ public: Concrete *operator->() const; private: - /// Pointer to of . + /// Pointer to @c this of . const Concrete *this_; }; diff --git a/ACE/ace/File_Lock.h b/ACE/ace/File_Lock.h index 4a6beab51f1..405b8c9f6e9 100644 --- a/ACE/ace/File_Lock.h +++ b/ACE/ace/File_Lock.h @@ -78,8 +78,8 @@ public: * Note, for interface uniformity with other synchronization * wrappers we include the method. This is implemented * as a write-lock to be on the safe-side... Returns -1 on failure. - * If we "failed" because someone else already had the lock, - * is set to . + * If we "failed" because someone else already had the lock, @c errno + * is set to @c EBUSY. */ int tryacquire (short whence = 0, ACE_OFF_T start = 0, ACE_OFF_T len = 1); @@ -93,14 +93,14 @@ public: /** * Conditionally acquire a write lock (i.e., won't block). Returns * -1 on failure. If we "failed" because someone else already had - * the lock, is set to . + * the lock, @c errno is set to @c EBUSY. */ int tryacquire_write (short whence = 0, ACE_OFF_T start = 0, ACE_OFF_T len = 1); /** * Conditionally upgrade to a write lock (i.e., won't block). Returns * -1 on failure. If we "failed" because someone else already had - * the lock, is set to . + * the lock, @c errno is set to @c EBUSY. */ int tryacquire_write_upgrade (short whence = 0, ACE_OFF_T start = 0, @@ -109,14 +109,14 @@ public: /** * Acquire a read lock, but block if a writer hold the lock. * Returns -1 on failure. If we "failed" because someone else - * already had the lock, is set to . + * already had the lock, @c errno is set to @c EBUSY. */ int acquire_read (short whence = 0, ACE_OFF_T start = 0, ACE_OFF_T len = 1); /** * Conditionally acquire a read lock (i.e., won't block). Returns * -1 on failure. If we "failed" because someone else already had - * the lock, is set to . + * the lock, @c errno is set to @c EBUSY. */ int tryacquire_read (short whence = 0, ACE_OFF_T start = 0, ACE_OFF_T len = 1); diff --git a/ACE/ace/Framework_Component.h b/ACE/ace/Framework_Component.h index 629205aa1b1..0541626ad31 100644 --- a/ACE/ace/Framework_Component.h +++ b/ACE/ace/Framework_Component.h @@ -120,7 +120,7 @@ public: /// resources, also called by dtor. int close (void); - /// Get pointer to a process-wide . + /// Get pointer to a process-wide ACE_Framework_Repository. static ACE_Framework_Repository *instance (int size = ACE_Framework_Repository::DEFAULT_SIZE); diff --git a/ACE/ace/Hash_Map_Manager_T.h b/ACE/ace/Hash_Map_Manager_T.h index ae9d41c2ae4..e36f44e58f2 100644 --- a/ACE/ace/Hash_Map_Manager_T.h +++ b/ACE/ace/Hash_Map_Manager_T.h @@ -612,10 +612,10 @@ public: /// Returns 1 when all items have been seen, else 0. int done (void) const; - /// Returns a reference to the interal element is pointing to. + /// Returns a reference to the interal element @c this is pointing to. ACE_Hash_Map_Entry& operator* (void) const; - /// Returns a pointer to the interal element is pointing to. + /// Returns a pointer to the interal element @c this is pointing to. ACE_Hash_Map_Entry* operator-> (void) const; /// Returns reference the Hash_Map_Manager_Ex that is being iterated @@ -679,10 +679,10 @@ public: /// Returns 1 when all items have been seen, else 0. int done (void) const; - /// Returns a reference to the interal element is pointing to. + /// Returns a reference to the interal element @c this is pointing to. ACE_Hash_Map_Entry& operator* (void) const; - /// Returns a pointer to the interal element is pointing to. + /// Returns a pointer to the interal element @c this is pointing to. ACE_Hash_Map_Entry* operator-> (void) const; /// Returns reference the Hash_Map_Manager_Ex that is being iterated @@ -866,10 +866,10 @@ public: /// Postfix reverse. ACE_Hash_Map_Bucket_Iterator operator-- (int); - /// Returns a reference to the interal element is pointing to. + /// Returns a reference to the interal element @c this is pointing to. ACE_Hash_Map_Entry& operator* (void) const; - /// Returns a pointer to the interal element is pointing to. + /// Returns a pointer to the interal element @c this is pointing to. ACE_Hash_Map_Entry* operator-> (void) const; /// Returns reference the Hash_Map_Manager_Ex that is being iterated diff --git a/ACE/ace/IOStream_T.h b/ACE/ace/IOStream_T.h index 0992bdc131d..9bf90cee122 100644 --- a/ACE/ace/IOStream_T.h +++ b/ACE/ace/IOStream_T.h @@ -92,7 +92,7 @@ protected: * can use it anywhere you would have used your original * class. * To create an iostream for your favorite ACE IPC class (e.g., - * ), feed that class to this template's + * ACE_SOCK_Stream), feed that class to this template's * parameter, e.g., * typedef ACE_Svc_Handler diff --git a/ACE/ace/Lock.h b/ACE/ace/Lock.h index 272683098c0..2b95c1962da 100644 --- a/ACE/ace/Lock.h +++ b/ACE/ace/Lock.h @@ -63,7 +63,7 @@ public: /** * Conditionally acquire the lock (i.e., won't block). Returns -1 * on failure. If we "failed" because someone else already had the - * lock, is set to . + * lock, @c errno is set to @c EBUSY. */ virtual int tryacquire (void) = 0; @@ -88,7 +88,7 @@ public: * Conditionally acquire a read lock. If the locking mechanism * doesn't support read locks then this just calls . * Returns -1 on failure. If we "failed" because someone else - * already had the lock, is set to . + * already had the lock, @c errno is set to @c EBUSY. */ virtual int tryacquire_read (void) = 0; @@ -96,7 +96,7 @@ public: * Conditionally acquire a write lock. If the locking mechanism * doesn't support read locks then this just calls . * Returns -1 on failure. If we "failed" because someone else - * already had the lock, is set to . + * already had the lock, @c errno is set to @c EBUSY. */ virtual int tryacquire_write (void) = 0; diff --git a/ACE/ace/Malloc_Allocator.h b/ACE/ace/Malloc_Allocator.h index 05aff9fdb9e..1ac2f9d55ee 100644 --- a/ACE/ace/Malloc_Allocator.h +++ b/ACE/ace/Malloc_Allocator.h @@ -45,7 +45,7 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL * This class uses the new/delete operators to allocate and free up * memory. Please note that the only methods that are supported are * , , and . All other methods are no-ops that - * return -1 and set to . If you require this + * return -1 and set @c errno to . If you require this * functionality, please use: ACE_Allocator_Adapter >, which will allow you to use the * added functionality of bind/find/etc. while using the new/delete diff --git a/ACE/ace/Map_Manager.h b/ACE/ace/Map_Manager.h index 0e34d6b30c7..e045f6ccf54 100644 --- a/ACE/ace/Map_Manager.h +++ b/ACE/ace/Map_Manager.h @@ -411,7 +411,7 @@ protected: /// Synchronization variable for the MT_SAFE ACE_Map_Manager. mutable ACE_LOCK lock_; - /// Implement the Map as a resizeable array of . + /// Implement the Map as a resizeable array of ACE_Map_Entry. ACE_Map_Entry *search_structure_; /// Total number of elements in this->search_structure_. @@ -467,7 +467,7 @@ public: /// Returns 1 when all items have been seen, else 0. int done (void) const; - /// Returns a reference to the interal element is pointing to. + /// Returns a reference to the interal element @c this is pointing to. ACE_Map_Entry& operator* (void) const; /// Returns reference the Map_Manager that is being iterated @@ -526,7 +526,7 @@ public: /// Returns 1 when all items have been seen, else 0. int done (void) const; - /// Returns a reference to the interal element is pointing to. + /// Returns a reference to the interal element @c this is pointing to. ACE_Map_Entry& operator* (void) const; /// Returns reference the Map_Manager that is being iterated diff --git a/ACE/ace/Map_T.h b/ACE/ace/Map_T.h index 2dd8f0b0f60..142d07803ce 100644 --- a/ACE/ace/Map_T.h +++ b/ACE/ace/Map_T.h @@ -558,7 +558,7 @@ public: implementation; // = Initialization and termination methods. - /// Initialize with the . + /// Initialize with the ACE_DEFAULT_MAP_SIZE. ACE_Map_Impl (ACE_Allocator *alloc = 0); /// Initialize with @a size entries. The @a size parameter is ignored @@ -840,7 +840,7 @@ public: implementation; // = Initialization and termination methods. - /// Initialize with the . + /// Initialize with the ACE_DEFAULT_MAP_SIZE. ACE_Active_Map_Manager_Adapter (ACE_Allocator *alloc = 0); /// Initialize with @a size entries. The @a size parameter is ignored @@ -1134,7 +1134,7 @@ public: implementation; // = Initialization and termination methods. - /// Initialize with the . + /// Initialize with the ACE_DEFAULT_MAP_SIZE. ACE_Hash_Map_Manager_Ex_Adapter (ACE_Allocator *alloc = 0); /// Initialize with @a size entries. The @a size parameter is ignored @@ -1420,7 +1420,7 @@ public: implementation; // = Initialization and termination methods. - /// Initialize with the . + /// Initialize with the ACE_DEFAULT_MAP_SIZE. ACE_Map_Manager_Adapter (ACE_Allocator *alloc = 0); /// Initialize with @a size entries. The @a size parameter is ignored diff --git a/ACE/ace/Message_Block.h b/ACE/ace/Message_Block.h index db52a13bb94..ed0728d17bc 100644 --- a/ACE/ace/Message_Block.h +++ b/ACE/ace/Message_Block.h @@ -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 - * and @a mb and return 0. Behavior is undefined if reference + * @c 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 3e1713ac712..a33faca251c 100644 --- a/ACE/ace/Message_Queue.h +++ b/ACE/ace/Message_Queue.h @@ -96,8 +96,8 @@ public: * Retrieve the first ACE_Message_Block without removing it. Note * that @a timeout uses <{absolute}> time rather than <{relative}> * time. If the @a timeout elapses without receiving a message -1 is - * returned and is set to . If the queue is - * deactivated -1 is returned and is set to . + * returned and @c errno is set to @c EWOULDBLOCK. If the queue is + * deactivated -1 is returned and @c errno is set to . * Otherwise, returns -1 on failure, else the number of items still * on the queue. */ @@ -108,10 +108,10 @@ public: * Enqueue a into the tail of the queue. * Returns number of items in queue if the call succeeds or -1 * otherwise. These calls return -1 when queue is closed, - * deactivated (in which case == ), when a signal - * occurs (in which case == , or if the time - * specified in timeout elapses (in which case == - * ). + * deactivated (in which case @c errno == ), when a signal + * occurs (in which case @c errno == , or if the time + * specified in timeout elapses (in which case @c errno == + * @c EWOULDBLOCK). */ virtual int enqueue_tail (ACE_Message_Block *new_item, ACE_Time_Value *timeout = 0) = 0; @@ -122,10 +122,10 @@ public: * Dequeue and return the at the head of the * queue. Returns number of items in queue if the call succeeds or * -1 otherwise. These calls return -1 when queue is closed, - * deactivated (in which case == ), when a signal - * occurs (in which case == , or if the time - * specified in timeout elapses (in which case == - * ). + * deactivated (in which case @c errno == ), when a signal + * occurs (in which case @c errno == , or if the time + * specified in timeout elapses (in which case @c errno == + * @c EWOULDBLOCK). */ virtual int dequeue_head (ACE_Message_Block *&first_item, ACE_Time_Value *timeout = 0) = 0; diff --git a/ACE/ace/Message_Queue_T.h b/ACE/ace/Message_Queue_T.h index 0d24f8c74aa..912fc565de4 100644 --- a/ACE/ace/Message_Queue_T.h +++ b/ACE/ace/Message_Queue_T.h @@ -414,7 +414,7 @@ public: * Deactivate the queue and wakeup all threads waiting on the queue * so they can continue. No messages are removed from the queue, * however. Any other operations called until the queue is - * activated again will immediately return -1 with == + * activated again will immediately return -1 with @c errno == * ESHUTDOWN. Returns WAS_INACTIVE if queue was inactive before the * call and WAS_ACTIVE if queue was active before the call. */ @@ -1293,7 +1293,7 @@ public: * Deactivate the queue and wakeup all threads waiting on the queue * so they can continue. No messages are removed from the queue, * however. Any other operations called until the queue is - * activated again will immediately return -1 with == + * activated again will immediately return -1 with @c errno == * ESHUTDOWN. Returns WAS_INACTIVE if queue was inactive before the * call and WAS_ACTIVE if queue was active before the call. */ diff --git a/ACE/ace/Name_Request_Reply.h b/ACE/ace/Name_Request_Reply.h index 9ab620349d4..3a927e9f9e3 100644 --- a/ACE/ace/Name_Request_Reply.h +++ b/ACE/ace/Name_Request_Reply.h @@ -249,7 +249,7 @@ private: ACE_INT32 type_; /// Indicates why error occurred if type_> == failure (-1). - /// Typical reasons include: (if the client timed out after + /// Typical reasons include: @c ETIME (if the client timed out after /// waiting for the name). ACE_UINT32 errno_; }; diff --git a/ACE/ace/Node.h b/ACE/ace/Node.h index 1e8530d89f2..023086dbb91 100644 --- a/ACE/ace/Node.h +++ b/ACE/ace/Node.h @@ -64,7 +64,7 @@ private: void operator= (const ACE_Node &); private: - /// Pointer to next element in the list of s. + /// Pointer to next element in the list of ACE_Nodes. ACE_Node *next_; /// Current value of the item in this node. diff --git a/ACE/ace/Null_Condition.h b/ACE/ace/Null_Condition.h index a72df210a51..e67f2a0bb41 100644 --- a/ACE/ace/Null_Condition.h +++ b/ACE/ace/Null_Condition.h @@ -50,10 +50,10 @@ public: /// Returns 0. int remove (void) {return 0;} - /// Returns -1 with == . + /// Returns -1 with @c errno == @c ETIME. int wait (const ACE_Time_Value * = 0) {errno = ETIME; return -1;} - /// Returns -1 with == . + /// Returns -1 with @c errno == @c ETIME. int wait (ACE_Null_Mutex &, const ACE_Time_Value * = 0) {errno = ETIME; return -1;} diff --git a/ACE/ace/Null_Mutex.h b/ACE/ace/Null_Mutex.h index 2072bf2db52..8d68c709d5a 100644 --- a/ACE/ace/Null_Mutex.h +++ b/ACE/ace/Null_Mutex.h @@ -54,10 +54,10 @@ public: /// Return 0. int acquire (void) {return 0;} - /// Return -1 with == . + /// Return -1 with @c errno == @c ETIME. int acquire (ACE_Time_Value &) {errno = ETIME; return -1;} - /// Return -1 with == . + /// Return -1 with @c errno == @c ETIME. int acquire (ACE_Time_Value *) {errno = ETIME; return -1;} /// Return 0. diff --git a/ACE/ace/Null_Semaphore.h b/ACE/ace/Null_Semaphore.h index 5a3597b805c..23650db7518 100644 --- a/ACE/ace/Null_Semaphore.h +++ b/ACE/ace/Null_Semaphore.h @@ -62,10 +62,10 @@ public: /// Return 0. int acquire (void) {return 0;} - /// Return -1 with == . + /// Return -1 with @c errno == @c ETIME. int acquire (ACE_Time_Value &) {errno = ETIME; return -1;} - /// Return -1 with == . + /// Return -1 with @c errno == @c ETIME. int acquire (ACE_Time_Value *) {errno = ETIME; return -1;} /// Return 0. diff --git a/ACE/ace/OS_Errno.h b/ACE/ace/OS_Errno.h index 077aff14ff8..2827a162b93 100644 --- a/ACE/ace/OS_Errno.h +++ b/ACE/ace/OS_Errno.h @@ -51,11 +51,11 @@ public: ACE_Errno_Guard (ACE_ERRNO_TYPE &errno_ref, int error); - /// Stash the value of into and initialize the + /// Stash the value of @c errno into and initialize the /// to the address of . ACE_Errno_Guard (ACE_ERRNO_TYPE &errno_ref); - /// Reset the value of to . + /// Reset the value of @c errno to . ~ACE_Errno_Guard (void); #if defined (ACE_HAS_WINCE_BROKEN_ERRNO) diff --git a/ACE/ace/OS_NS_Thread.h b/ACE/ace/OS_NS_Thread.h index c3a2125568e..829f77cfa06 100644 --- a/ACE/ace/OS_NS_Thread.h +++ b/ACE/ace/OS_NS_Thread.h @@ -1303,7 +1303,7 @@ namespace ACE_OS { * If == 0, calls . Otherwise, * this method attempts to acquire a lock, but gives up if the lock * has not been acquired by the given time, in which case it returns - * -1 with an errno on platforms that actually support timed + * -1 with an @c ETIME errno on platforms that actually support timed * mutexes. The timeout should be an absolute time. Note that the * mutex should not be a recursive one, i.e., it should only be a * standard mutex or an error checking mutex since some diff --git a/ACE/ace/OS_NS_errno.h b/ACE/ace/OS_NS_errno.h index 9ff085429b2..85e85735b2c 100644 --- a/ACE/ace/OS_NS_errno.h +++ b/ACE/ace/OS_NS_errno.h @@ -55,7 +55,7 @@ namespace ACE_OS { /** * @class ACE_CE_Errno * - * Some versions of CE don't support and some versions' + * Some versions of CE don't support @c errno and some versions' * implementations are busted. So we implement our own. * Our implementation takes up one Tls key, however, it does not * allocate memory fromt the heap so there's no problem with cleanin diff --git a/ACE/ace/POSIX_Asynch_IO.h b/ACE/ace/POSIX_Asynch_IO.h index 243fddc990f..8ab2b084daf 100644 --- a/ACE/ace/POSIX_Asynch_IO.h +++ b/ACE/ace/POSIX_Asynch_IO.h @@ -101,7 +101,7 @@ public: */ int signal_number (void) const; - /// Post to the Proactor. + /// Post @c this to the Proactor. int post_completion (ACE_Proactor_Impl *proactor); /// Destructor. diff --git a/ACE/ace/Process_Mutex.h b/ACE/ace/Process_Mutex.h index 6d4cffdb297..c2fb3c702da 100644 --- a/ACE/ace/Process_Mutex.h +++ b/ACE/ace/Process_Mutex.h @@ -160,14 +160,14 @@ public: /** * Conditionally acquire a lock (i.e., won't block). Returns -1 on * failure. If we "failed" because someone else already had the - * lock, is set to . + * lock, @c errno is set to @c EBUSY. */ int tryacquire_read (void); /** * Conditionally acquire a lock (i.e., won't block). Returns -1 on * failure. If we "failed" because someone else already had the - * lock, is set to . + * lock, @c errno is set to @c EBUSY. */ int tryacquire_write (void); diff --git a/ACE/ace/Process_Semaphore.h b/ACE/ace/Process_Semaphore.h index 39c86e2e640..1b95d497445 100644 --- a/ACE/ace/Process_Semaphore.h +++ b/ACE/ace/Process_Semaphore.h @@ -96,7 +96,7 @@ public: * and is only here to make the * interface consistent with the other synchronization APIs. * Returns -1 on failure. If we "failed" because someone else - * already had the lock, is set to . + * already had the lock, @c errno is set to @c EBUSY. */ int tryacquire_read (void); @@ -105,7 +105,7 @@ public: * and is only here to make the ACE_Process_Semaphore * interface consistent with the other synchronization APIs. * Returns -1 on failure. If we "failed" because someone else - * already had the lock, is set to . + * already had the lock, @c errno is set to @c EBUSY. */ int tryacquire_write (void); diff --git a/ACE/ace/RB_Tree.h b/ACE/ace/RB_Tree.h index 9fc7e5e45eb..8b7215816e6 100644 --- a/ACE/ace/RB_Tree.h +++ b/ACE/ace/RB_Tree.h @@ -570,7 +570,7 @@ private: // = Private members. - /// Synchronization variable for the MT_SAFE . + /// Synchronization variable for the MT_SAFE ACE_RB_Tree. ACE_LOCK lock_; /// The root of the tree. diff --git a/ACE/ace/RW_Mutex.h b/ACE/ace/RW_Mutex.h index 3c1373b5008..1bc6b258d2b 100644 --- a/ACE/ace/RW_Mutex.h +++ b/ACE/ace/RW_Mutex.h @@ -66,7 +66,7 @@ public: /** * Conditionally acquire a read lock (i.e., won't block). Returns * -1 on failure. If we "failed" because someone else already had - * the lock, is set to . + * the lock, @c errno is set to @c EBUSY. */ int tryacquire_read (void); @@ -77,7 +77,7 @@ public: * Conditionally upgrade a read lock to a write lock. This only * works if there are no other readers present, in which case the * method returns 0. Otherwise, the method returns -1 and sets - * to . Note that the caller of this method *must* + * @c errno to @c EBUSY. Note that the caller of this method *must* * already possess this lock as a read lock (but this condition is * not checked by the current implementation). */ @@ -94,8 +94,8 @@ public: * Note, for interface uniformity with other synchronization * wrappers we include the method. This is implemented * as a write-lock to be safe... Returns -1 on failure. If we - * "failed" because someone else already had the lock, is - * set to . + * "failed" because someone else already had the lock, @c errno is + * set to @c EBUSY. */ int tryacquire (void); diff --git a/ACE/ace/RW_Process_Mutex.h b/ACE/ace/RW_Process_Mutex.h index a34b6f9f404..4676d930e31 100644 --- a/ACE/ace/RW_Process_Mutex.h +++ b/ACE/ace/RW_Process_Mutex.h @@ -71,7 +71,7 @@ public: /** * Conditionally acquire lock (i.e., don't wait on queue). Returns * -1 on failure. If we "failed" because someone else already had - * the lock, is set to . + * the lock, @c errno is set to @c EBUSY. */ int tryacquire (void); @@ -87,14 +87,14 @@ public: /** * Conditionally acquire a lock (i.e., won't block). Returns -1 on * failure. If we "failed" because someone else already had the - * lock, is set to . + * lock, @c errno is set to @c EBUSY. */ int tryacquire_read (void); /** * Conditionally acquire a lock (i.e., won't block). Returns -1 on * failure. If we "failed" because someone else already had the - * lock, is set to . + * lock, @c errno is set to @c EBUSY. */ int tryacquire_write (void); diff --git a/ACE/ace/RW_Thread_Mutex.h b/ACE/ace/RW_Thread_Mutex.h index e42b7a33520..ba903df4f76 100644 --- a/ACE/ace/RW_Thread_Mutex.h +++ b/ACE/ace/RW_Thread_Mutex.h @@ -49,7 +49,7 @@ public: * Conditionally upgrade a read lock to a write lock. This only * works if there are no other readers present, in which case the * method returns 0. Otherwise, the method returns -1 and sets - * to . Note that the caller of this method *must* + * @c errno to @c EBUSY. Note that the caller of this method *must* * already possess this lock as a read lock (but this condition is * not checked by the current implementation). */ diff --git a/ACE/ace/Recursive_Thread_Mutex.h b/ACE/ace/Recursive_Thread_Mutex.h index 5ce635cac12..38effc66afb 100644 --- a/ACE/ace/Recursive_Thread_Mutex.h +++ b/ACE/ace/Recursive_Thread_Mutex.h @@ -64,7 +64,7 @@ public: /** * Block the thread until we acquire the mutex or until @a tv times - * out, in which case -1 is returned with == . Note + * out, in which case -1 is returned with @c errno == @c ETIME. Note * that @a tv is assumed to be in "absolute" rather than "relative" * time. The value of @a tv is updated upon return to show the * actual (absolute) acquisition time. @@ -74,7 +74,7 @@ public: /** * If @a tv == 0 the call directly. Otherwise, Block the * thread until we acquire the mutex or until @a tv times out, in - * which case -1 is returned with == . Note that + * which case -1 is returned with @c errno == @c ETIME. Note that * <*tv> is assumed to be in "absolute" rather than "relative" time. * The value of <*tv> is updated upon return to show the actual * (absolute) acquisition time. @@ -84,7 +84,7 @@ public: /** * Conditionally acquire a recursive mutex (i.e., won't block). * Returns -1 on failure. If we "failed" because someone else - * already had the lock, is set to . + * already had the lock, @c errno is set to @c EBUSY. */ int tryacquire (void); @@ -107,8 +107,8 @@ public: * and is only here to make the * interface consistent with the other * synchronization APIs. Returns -1 on failure. If we "failed" - * because someone else already had the lock, is set to - * . + * because someone else already had the lock, @c errno is set to + * @c EBUSY. */ int tryacquire_read (void); @@ -117,8 +117,8 @@ public: * and is only here to make the * interface consistent with the other * synchronization APIs. Returns -1 on failure. If we "failed" - * because someone else already had the lock, is set to - * . + * because someone else already had the lock, @c errno is set to + * @c EBUSY. */ int tryacquire_write (void); diff --git a/ACE/ace/Refcounted_Auto_Ptr.h b/ACE/ace/Refcounted_Auto_Ptr.h index 6367396b9a6..edcd6ca688b 100644 --- a/ACE/ace/Refcounted_Auto_Ptr.h +++ b/ACE/ace/Refcounted_Auto_Ptr.h @@ -110,7 +110,7 @@ protected: /// the ACE_Refcounted_Auto_Ptr_Rep typedef ACE_Refcounted_Auto_Ptr_Rep AUTO_REFCOUNTED_PTR_REP; - /// Protect operations on the . + /// Protect operations on the ACE_Refcounted_Auto_Ptr. AUTO_REFCOUNTED_PTR_REP *rep_; }; diff --git a/ACE/ace/Registry.h b/ACE/ace/Registry.h index 88ffd807d49..faa4a62098f 100644 --- a/ACE/ace/Registry.h +++ b/ACE/ace/Registry.h @@ -226,36 +226,36 @@ public: const Object &object); /** - * Insert or update with into context + * Insert or update with into @c this context * This will not fail if already exists * (String version) */ int bind (const ACE_TString &name, const Object &object); - /// Update with in context + /// Update with in @c this context /// (Name version) int rebind (const Name &name, const Object &object); - /// Update with in context + /// Update with in @c this context int rebind (const ACE_TString &name, const Object &object); - /// Find with in context + /// Find with in @c this context /// (Name version) int resolve (const Name &name, Object &object); - /// Find with in context + /// Find with in @c this context int resolve (const ACE_TString &name, Object &object); - /// Delete object with in context + /// Delete object with in @c this context /// (Name version) int unbind (const Name &name); - /// Delete object with in context + /// Delete object with in @c this context int unbind (const ACE_TString &name); @@ -265,7 +265,7 @@ public: int new_context (Naming_Context &naming_context); /** - * Insert with relative to context + * Insert with relative to @c this context * This will fail if already exists * (Name version) */ @@ -275,7 +275,7 @@ public: u_long security_access = KEY_ALL_ACCESS, LPSECURITY_ATTRIBUTES security_attributes = 0); - /// Insert with relative to context + /// Insert with relative to @c this context /// This will fail if already exists int bind_new_context (const ACE_TString &name, Naming_Context &naming_context, @@ -284,7 +284,7 @@ public: LPSECURITY_ATTRIBUTES security_attributes = 0); /** - * Insert or update with relative to context + * Insert or update with relative to @c this context * This will not fail if already exists * (Name version) */ @@ -294,7 +294,7 @@ public: u_long security_access = KEY_ALL_ACCESS, LPSECURITY_ATTRIBUTES security_attributes = 0); - /// Insert or update with relative to context + /// Insert or update with relative to @c this context /// This will not fail if already exists int bind_context (const ACE_TString &name, /* const */ Naming_Context &naming_context, @@ -311,31 +311,31 @@ public: int rebind_context (const ACE_TString &name, /* const */ Naming_Context &naming_context); - /// Find with in context + /// Find with in @c this context /// (Name version) int resolve_context (const Name &name, Naming_Context &naming_context, u_long security_access = KEY_ALL_ACCESS); - /// Find with in context + /// Find with in @c this context int resolve_context (const ACE_TString &name, Naming_Context &naming_context, u_long security_access = KEY_ALL_ACCESS); - /// Remove naming_context with from context + /// Remove naming_context with from @c this context /// (Name version) int unbind_context (const Name &name); - /// Remove naming_context with from context + /// Remove naming_context with from @c this context int unbind_context (const ACE_TString &name); - /// Same as with as naming_context + /// Same as with @c this as naming_context int destroy (void); /** * listing function: iterator creator * This is useful when there are many objects and contexts - * in context and you only want to look at a few entries + * in @c this context and you only want to look at a few entries * at a time */ int list (u_long how_many, @@ -343,7 +343,7 @@ public: Binding_Iterator &iterator); /// listing function: iterator creator - /// This gives back a listing of all entries in context. + /// This gives back a listing of all entries in @c this context. int list (Binding_List &list); // Some other necessary functions which are diff --git a/ACE/ace/Remote_Tokens.h b/ACE/ace/Remote_Tokens.h index ec39d3d26eb..e9c9625aa2d 100644 --- a/ACE/ace/Remote_Tokens.h +++ b/ACE/ace/Remote_Tokens.h @@ -79,7 +79,7 @@ public: * token is already held, the owner is notified. options contains * the timeout value for the acquire call. The timer is kept at the * token server. Asynchronous operations are not supported. - * Returns 0 on success, -1 on failure with == problem. + * Returns 0 on success, -1 on failure with @c errno == problem. */ virtual int acquire (int notify = 0, void (*sleep_hook)(void *) = 0, @@ -114,7 +114,7 @@ public: /** * Release the distributed token. Similar to ACE_Local_Mutex, if the * caller is not the owner, it is removed from the waiter list (if - * applicable.) Returns 0 on success, -1 on failure with == + * applicable.) Returns 0 on success, -1 on failure with @c errno == * problem. */ virtual int release (ACE_Synch_Options &options = diff --git a/ACE/ace/SOCK.h b/ACE/ace/SOCK.h index 4d97aef26a3..6dcffcb4114 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 . + * 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 35e112c1aa3..8aa3f1f8a3a 100644 --- a/ACE/ace/SOCK_Acceptor.h +++ b/ACE/ace/SOCK_Acceptor.h @@ -28,7 +28,7 @@ class ACE_Accept_QoS_Params; /** * @class ACE_SOCK_Acceptor * - * @brief Defines a factory that creates new s passively. + * @brief Defines a factory that creates new ACE_Streams passively. * * The ACE_SOCK_Acceptor has its own "passive-mode" socket. * This serves as a factory to create so-called "data-mode" @@ -98,11 +98,11 @@ public: // = Passive connection methods. /** - * Accept a new connection. A @a timeout of 0 + * Accept a new ACE_SOCK_Stream connection. A @a timeout of 0 * means block forever, a @a timeout of {0, 0} means poll. * == 1 means "restart if interrupted," i.e., if errno == EINTR. - * Note that inherits the "blocking mode" of - * ACE_SOCK_Acceptor, i.e., if acceptor factory is in + * Note that inherits the "blocking mode" of @c this + * ACE_SOCK_Acceptor, i.e., if @c this acceptor factory is in * non-blocking mode, the will be in non-blocking mode * and vice versa. */ @@ -114,12 +114,12 @@ public: #if !defined (ACE_HAS_WINCE) /** - * Accept a new connection using the QoS + * Accept a new ACE_SOCK_Stream connection using the QoS * information in . A @a timeout of 0 means block * forever, a @a timeout of {0, 0} means poll. == 1 means * "restart if interrupted," i.e., if errno == EINTR. Note that - * inherits the "blocking mode" of - * ACE_SOCK_Acceptor, i.e., if acceptor factory is in + * inherits the "blocking mode" of @c this + * ACE_SOCK_Acceptor, i.e., if @c this acceptor factory is in * non-blocking mode, the will be in non-blocking mode * and vice versa. */ diff --git a/ACE/ace/SOCK_SEQPACK_Acceptor.h b/ACE/ace/SOCK_SEQPACK_Acceptor.h index 7455600b985..4872a9cfb00 100644 --- a/ACE/ace/SOCK_SEQPACK_Acceptor.h +++ b/ACE/ace/SOCK_SEQPACK_Acceptor.h @@ -34,11 +34,11 @@ class ACE_Time_Value; /** * @class ACE_SOCK_SEQPACK_Acceptor * - * @brief Defines a factory that creates new s passively. + * @brief Defines a factory that creates new ACE_Associations passively. * * The has its own "passive-mode" socket. * This serves as a factory to create so-called "data-mode" - * sockets, which are what the encapsulates. + * sockets, which are what the ACE_SOCK_SEQPACK_Association encapsulates. * Therefore, by inheriting from , * gets its very own socket. */ @@ -122,11 +122,11 @@ public: // = Passive connection methods. /** - * Accept a new connection. A @a timeout of 0 + * Accept a new ACE_SOCK_SEQPACK_Association connection. A @a timeout of 0 * means block forever, a @a timeout of {0, 0} means poll. * == 1 means "restart if interrupted," i.e., if errno == EINTR. - * Note that inherits the "blocking mode" of - * , i.e., if acceptor factory is in + * Note that inherits the "blocking mode" of @c this + * , i.e., if @c this acceptor factory is in * non-blocking mode, the will be in non-blocking mode * and vice versa. */ diff --git a/ACE/ace/SOCK_SEQPACK_Association.h b/ACE/ace/SOCK_SEQPACK_Association.h index be668d4461d..db4e50eb2e7 100644 --- a/ACE/ace/SOCK_SEQPACK_Association.h +++ b/ACE/ace/SOCK_SEQPACK_Association.h @@ -37,7 +37,7 @@ class ACE_Message_Block; /** * @class ACE_SOCK_SEQPACK_Association * - * @brief Defines the methods in the abstraction. + * @brief Defines the methods in the ACE_SOCK_SEQPACK_Association abstraction. * * This adds additional wrapper methods atop the * class. diff --git a/ACE/ace/SString.h b/ACE/ace/SString.h index 498d1962d05..b52c732ef55 100644 --- a/ACE/ace/SString.h +++ b/ACE/ace/SString.h @@ -385,7 +385,7 @@ public: protected: /// Returns 1 if is a delimiter, 0 otherwise. If should be - /// replaced with , is set to 1, otherwise 0. + /// replaced with @a r, is set to 1, otherwise 0. int is_delimiter (ACE_TCHAR d, int &replace, ACE_TCHAR &r); /** diff --git a/ACE/ace/Semaphore.h b/ACE/ace/Semaphore.h index d0bcc2324a0..96064adfdd1 100644 --- a/ACE/ace/Semaphore.h +++ b/ACE/ace/Semaphore.h @@ -61,7 +61,7 @@ public: /** * Block the thread until the semaphore count becomes greater than 0 * (at which point it is decremented) or until @a tv times out (in - * which case -1 is returned and == ). Note that @a tv + * which case -1 is returned and @c errno == @c ETIME). Note that @a tv * is assumed to be in "absolute" rather than "relative" time. The * value of @a tv is updated upon return to show the actual * (absolute) acquisition time. @@ -79,7 +79,7 @@ public: * If @a tv == 0 then call directly. Otherwise, Block * the thread until the semaphore count becomes greater than 0 * (at which point it is decremented) or until @a tv times out (in - * which case -1 is returned and == ). Note that + * which case -1 is returned and @c errno == @c ETIME). Note that * <*tv> is assumed to be in "absolute" rather than "relative" time. * The value of <*tv> is updated upon return to show the actual * (absolute) acquisition time. @@ -95,8 +95,8 @@ public: /** * Conditionally decrement the semaphore if count is greater than 0 * (i.e., won't block). Returns -1 on failure. If we "failed" - * because someone else already had the lock, is set to - * . + * because someone else already had the lock, @c errno is set to + * @c EBUSY. */ int tryacquire (void); @@ -127,7 +127,7 @@ public: * and is only here to make the ACE_Semaphore * interface consistent with the other synchronization APIs. * Returns -1 on failure. If we "failed" because someone else - * already had the lock, is set to . + * already had the lock, @c errno is set to @c EBUSY. */ int tryacquire_read (void); @@ -136,7 +136,7 @@ public: * and is only here to make the ACE_Semaphore * interface consistent with the other synchronization APIs. * Returns -1 on failure. If we "failed" because someone else - * already had the lock, is set to . + * already had the lock, @c errno is set to @c EBUSY. */ int tryacquire_write (void); diff --git a/ACE/ace/Service_Types.h b/ACE/ace/Service_Types.h index 5888be064e8..fccf76b5f02 100644 --- a/ACE/ace/Service_Types.h +++ b/ACE/ace/Service_Types.h @@ -162,7 +162,7 @@ class ACE_Export ACE_Stream_Type : public ACE_Service_Type_Impl { public: // = Initialization method. - ACE_Stream_Type (void *s, // Really an *. + ACE_Stream_Type (void *s, // Really an ACE_Stream *. const ACE_TCHAR *identifier, u_int flags = 0); diff --git a/ACE/ace/Signal.h b/ACE/ace/Signal.h index 188bb770bd9..952ac517b59 100644 --- a/ACE/ace/Signal.h +++ b/ACE/ace/Signal.h @@ -175,7 +175,7 @@ public: ~ACE_Sig_Action (void); // = Signal action management. - /// Register as the current disposition and store old + /// Register @c this as the current disposition and store old /// disposition into if it is non-NULL. int register_action (int signum, ACE_Sig_Action *oaction = 0); diff --git a/ACE/ace/Stream.h b/ACE/ace/Stream.h index b51e3c23880..da558b89d4b 100644 --- a/ACE/ace/Stream.h +++ b/ACE/ace/Stream.h @@ -41,7 +41,7 @@ class ACE_Time_Value; * contains two . Even though the methods in this * class are virtual, this class isn't really intended for * subclassing unless you know what you are doing. In - * particular, the destructor calls , which + * particular, the ACE_Stream destructor calls , which * won't be overridden properly unless you call it in a subclass * destructor. */ @@ -195,7 +195,7 @@ private: /** * @class ACE_Stream_Iterator * - * @brief Iterate through an . + * @brief Iterate through an ACE_Stream. */ template class ACE_Stream_Iterator diff --git a/ACE/ace/Task.h b/ACE/ace/Task.h index be7272e246a..11aaaad87ea 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 ACE_Task_Base *'s + * ACE_Thread_Manager to store ACE_Task_Base *'s * polymorphically. */ class ACE_Export ACE_Task_Base : public ACE_Service_Object @@ -156,14 +156,14 @@ public: * * 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 + * handles being spawned. Returns -1 on failure (@c errno will * explain...), otherwise returns the group id of the threads. * * Assigning allows you to associate the newly spawned * threads with an instance of ACE_Task_Base. If == 0, then - * the new threads are associated automatically with + * the new threads are associated automatically with @c this * ACE_Task_Base. Setting the argument to value other than - * makes the thread manipulating methods, such as wait(), + * @c this makes the thread manipulating methods, such as wait(), * suspend(), resume(), useless. Threads spawned with user * specified value must therefore be manipulated thru * ACE_Thread_Manager directly. diff --git a/ACE/ace/Thread.h b/ACE/ace/Thread.h index f3d8632b6f5..5eca4cb16f7 100644 --- a/ACE/ace/Thread.h +++ b/ACE/ace/Thread.h @@ -44,7 +44,7 @@ struct cancel_state * This class provides a common interface that is mapped onto * POSIX Pthreads, Solaris threads, Win32 threads, VxWorks * threads, or pSoS threads. Note, however, that it is - * generally a better idea to use the + * generally a better idea to use the ACE_Thread_Manager * programming API rather than the API since the * thread manager is more powerful. */ @@ -127,7 +127,7 @@ public: * 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 + * number requested then something has gone wrong and @c errno will * explain...). * * @see spawn() diff --git a/ACE/ace/Thread_Adapter.h b/ACE/ace/Thread_Adapter.h index 454661387e3..9b2c8dd22a1 100644 --- a/ACE/ace/Thread_Adapter.h +++ b/ACE/ace/Thread_Adapter.h @@ -60,7 +60,7 @@ public: /** * Execute the with the . This function deletes - * , thereby rendering the object useless after the call + * @c this, thereby rendering the object useless after the call * returns. */ virtual ACE_THR_FUNC_RETURN invoke (void); diff --git a/ACE/ace/Thread_Exit.h b/ACE/ace/Thread_Exit.h index b6f29806e1d..77f1b8e3c1d 100644 --- a/ACE/ace/Thread_Exit.h +++ b/ACE/ace/Thread_Exit.h @@ -45,7 +45,7 @@ public: /// Capture the Thread that will be cleaned up automatically. ACE_Thread_Exit (void); - /// Set the . + /// Set the ACE_Thread_Manager. void thr_mgr (ACE_Thread_Manager *tm); /// Destructor calls the thread-specific exit hooks when a thread @@ -61,7 +61,7 @@ public: private: /// Automatically add/remove the thread from the - /// . + /// ACE_Thread_Manager. ACE_Thread_Control thread_control_; /** diff --git a/ACE/ace/Thread_Manager.h b/ACE/ace/Thread_Manager.h index 22adcb4a8d9..c6939117103 100644 --- a/ACE/ace/Thread_Manager.h +++ b/ACE/ace/Thread_Manager.h @@ -97,20 +97,20 @@ public: /// The destructor virtual ~ACE_At_Thread_Exit (void); - /// has the ownership? + /// At_Thread_Exit has the ownership? int is_owner (void) const; - /// Set the ownership of the . + /// Set the ownership of the At_Thread_Exit. int is_owner (int owner); - /// This was applied? + /// This At_Thread_Exit was applied? int was_applied (void) const; - /// Set applied state of . + /// Set applied state of At_Thread_Exit. int was_applied (int applied); protected: - /// The next hook in the list. + /// The next At_Thread_Exit hook in the list. ACE_At_Thread_Exit *next_; /// Do the apply if necessary @@ -438,10 +438,10 @@ public: ~ACE_Thread_Manager (void); #if ! defined (ACE_THREAD_MANAGER_LACKS_STATICS) - /// Get pointer to a process-wide . + /// Get pointer to a process-wide ACE_Thread_Manager. static ACE_Thread_Manager *instance (void); - /// Set pointer to a process-wide and return + /// Set pointer to a process-wide ACE_Thread_Manager and return /// existing pointer. static ACE_Thread_Manager *instance (ACE_Thread_Manager *); @@ -514,9 +514,9 @@ public: * * The argument is usually assigned by * . It associates the newly spawned - * threads with an ACE_Task instance, which defaults to . + * threads with an ACE_Task instance, which defaults to @c this. * - * @retval -1 on failure ( will explain...), otherwise returns the + * @retval -1 on failure (@c errno will explain...), otherwise returns the * group id of the threads. */ int spawn_n (size_t n, @@ -554,9 +554,9 @@ public: * * The argument is usually assigned by * . It associates the newly spawned - * threads with an ACE_Task instance, which defaults to . + * threads with an ACE_Task instance, which defaults to @c this. * - * @retval -1 on failure ( will explain...), otherwise returns the + * @retval -1 on failure (@c errno will explain...), otherwise returns the * group id of the threads. */ int spawn_n (ACE_thread_t thread_ids[], @@ -1118,7 +1118,7 @@ protected: private: #if ! defined (ACE_THREAD_MANAGER_LACKS_STATICS) - /// Pointer to a process-wide . + /// Pointer to a process-wide ACE_Thread_Manager. static ACE_Thread_Manager *thr_mgr_; /// Must delete the if non-0. diff --git a/ACE/ace/Thread_Mutex.h b/ACE/ace/Thread_Mutex.h index 9e70cdd3d82..0b44ef310da 100644 --- a/ACE/ace/Thread_Mutex.h +++ b/ACE/ace/Thread_Mutex.h @@ -70,7 +70,7 @@ public: /** * Block the thread until we acquire the mutex or until @a tv times - * out, in which case -1 is returned with == . Note + * out, in which case -1 is returned with @c errno == @c ETIME. Note * that @a tv is assumed to be in "absolute" rather than "relative" * time. The value of @a tv is updated upon return to show the * actual (absolute) acquisition time. @@ -80,7 +80,7 @@ public: /** * If @a tv == 0 the call directly. Otherwise, Block the * thread until we acquire the mutex or until @a tv times out, in - * which case -1 is returned with == . Note that + * which case -1 is returned with @c errno == @c ETIME. Note that * <*tv> is assumed to be in "absolute" rather than "relative" time. * The value of <*tv> is updated upon return to show the actual * (absolute) acquisition time. @@ -90,7 +90,7 @@ public: /** * Conditionally acquire lock (i.e., don't wait on queue). Returns * -1 on failure. If we "failed" because someone else already had - * the lock, is set to . + * the lock, @c errno is set to @c EBUSY. */ int tryacquire (void); @@ -116,7 +116,7 @@ public: * and is only here to make the ACE_Thread_Mutex * interface consistent with the other synchronization APIs. * Returns -1 on failure. If we "failed" because someone else - * already had the lock, is set to . + * already had the lock, @c errno is set to @c EBUSY. */ int tryacquire_read (void); @@ -125,7 +125,7 @@ public: * and is only here to make the ACE_Thread_Mutex * interface consistent with the other synchronization APIs. * Returns -1 on failure. If we "failed" because someone else - * already had the lock, is set to . + * already had the lock, @c errno is set to @c EBUSY. */ int tryacquire_write (void); diff --git a/ACE/ace/Timer_Hash_T.h b/ACE/ace/Timer_Hash_T.h index c7eee094c63..595193404c5 100644 --- a/ACE/ace/Timer_Hash_T.h +++ b/ACE/ace/Timer_Hash_T.h @@ -279,7 +279,7 @@ private: virtual int dispatch_info_i (const ACE_Time_Value ¤t_time, ACE_Timer_Node_Dispatch_Info_T &info); - /// Reschedule an "interval" . + /// Reschedule an "interval" ACE_Timer_Node. virtual void reschedule (ACE_Timer_Node_T *); /// Finds the earliest node diff --git a/ACE/ace/Timer_Heap_T.h b/ACE/ace/Timer_Heap_T.h index 0b545adf559..632c92ddb77 100644 --- a/ACE/ace/Timer_Heap_T.h +++ b/ACE/ace/Timer_Heap_T.h @@ -204,7 +204,7 @@ protected: const ACE_Time_Value &future_time, const ACE_Time_Value &interval); - /// Reschedule an "interval" . + /// Reschedule an "interval" ACE_Timer_Node. virtual void reschedule (ACE_Timer_Node_T *); /// Factory method that allocates a new node (uses operator new if @@ -219,7 +219,7 @@ protected: virtual void free_node (ACE_Timer_Node_T *); private: - /// Remove and return the th and restore the + /// Remove and return the th ACE_Timer_Node and restore the /// heap property. ACE_Timer_Node_T *remove (size_t slot); @@ -276,16 +276,16 @@ private: /** * Current contents of the Heap, which is organized as a "heap" of - * *'s. In this context, a heap is a "partially + * ACE_Timer_Node *'s. In this context, a heap is a "partially * ordered, almost complete" binary tree, which is stored in an * array. */ ACE_Timer_Node_T **heap_; /** - * An array of "pointers" that allows each in the + * An array of "pointers" that allows each ACE_Timer_Node in the * to be located in O(1) time. Basically, - * contains the slot in the array where an + * contains the slot in the array where an ACE_Timer_Node * * with timer id \ resides. Thus, the timer id passed back from * is really a slot into the array. The * array serves two purposes: negative values are @@ -305,7 +305,7 @@ private: /** * If this is non-0, then we preallocate number of - * objects in order to reduce dynamic allocation + * ACE_Timer_Node objects in order to reduce dynamic allocation * costs. In auto-growing implementation, this points to the * last array of nodes allocated. */ diff --git a/ACE/ace/Timer_Queue_T.h b/ACE/ace/Timer_Queue_T.h index f780d8a5240..69b71502eef 100644 --- a/ACE/ace/Timer_Queue_T.h +++ b/ACE/ace/Timer_Queue_T.h @@ -418,7 +418,7 @@ protected: const ACE_Time_Value &future_time, const ACE_Time_Value &interval) = 0; - /// Reschedule an "interval" . + /// Reschedule an "interval" ACE_Timer_Node. virtual void reschedule (ACE_Timer_Node_T *) = 0; /// Factory method that allocates a new node. diff --git a/ACE/ace/Token_Collection.h b/ACE/ace/Token_Collection.h index 9dc5aa522ca..fa91532aaa6 100644 --- a/ACE/ace/Token_Collection.h +++ b/ACE/ace/Token_Collection.h @@ -76,7 +76,7 @@ public: * operations performed on the collection will also be performed on * the new_proxy until it is removed. Note that no operations * performed prior to the insertion will be performed. Returns: 0 - * on success, -1 on failure with == problem. If a token + * on success, -1 on failure with @c errno == problem. If a token * proxy already exists in the collection with the same name, the * insertion will fail. Also, is copied. Note that during * the copy, client_id's are *not* inherited. The client ID of the @@ -121,7 +121,7 @@ public: * Acquire "atomically" all resources in the collection. This is * only successfull if all tokens in the collection could be * acquired. options contains the blocking semantics, timeout - * value, etc. Returns: 0 on success, -1 on failure with == + * value, etc. Returns: 0 on success, -1 on failure with @c errno == * problem. If and error or deadlock occurs for one of the tokens, * all the tokens will be released and the method will return -1. * Note that returning on detection of deadlock prevents livelock @@ -155,7 +155,7 @@ public: * Renews "atomically" all resources in the collection. This is * only successfull if all tokens in the collection could be * renewed. options contains the blocking semantics, timeout - * value, etc. Returns: 0 on success, -1 on failure with == + * value, etc. Returns: 0 on success, -1 on failure with @c errno == * problem. */ virtual int renew (int requeue_position = 0, @@ -174,7 +174,7 @@ public: * Releases "atomically" all resources in the collection. This is * only successfull if all tokens in the collection could be * released. options contains the blocking semantics, timeout - * value, etc. Returns: 0 on success, -1 on failure with == + * value, etc. Returns: 0 on success, -1 on failure with @c errno == * problem. */ virtual int release (ACE_Synch_Options &options = diff --git a/ACE/ace/Token_Request_Reply.h b/ACE/ace/Token_Request_Reply.h index 15dea490bc7..4341eb65cd5 100644 --- a/ACE/ace/Token_Request_Reply.h +++ b/ACE/ace/Token_Request_Reply.h @@ -246,8 +246,8 @@ private: /// Indicates why error occurred if type_> == . /// Typical reasons include: - /// (if client requested a non-blocking check for the token). - /// (if the client timed out after waiting for the token). + /// @c EWOULDBLOCK (if client requested a non-blocking check for the token). + /// @c ETIME (if the client timed out after waiting for the token). /// (if the token lock was removed out from underneath a waiter). /// (attempt to renew a token that isn't owned by the client). ACE_UINT32 errno_; diff --git a/ACE/ace/Unbounded_Set.h b/ACE/ace/Unbounded_Set.h index 5746a887d5f..46b0fcf6a73 100644 --- a/ACE/ace/Unbounded_Set.h +++ b/ACE/ace/Unbounded_Set.h @@ -65,7 +65,7 @@ public: /// Prefix advance. ACE_Unbounded_Set_Iterator& operator++ (void); - /// Returns a reference to the internal element is pointing to. + /// Returns a reference to the internal element @c this is pointing to. T& operator* (void); /// Check if two iterators point to the same position @@ -125,7 +125,7 @@ public: /// Prefix advance. ACE_Unbounded_Set_Const_Iterator& operator++ (void); - /// Returns a reference to the internal element is pointing to. + /// Returns a reference to the internal element @c this is pointing to. T& operator* (void); /// Check if two iterators point to the same position diff --git a/ACE/ace/WIN32_Asynch_IO.h b/ACE/ace/WIN32_Asynch_IO.h index d49072e9fe8..5dce2528396 100644 --- a/ACE/ace/WIN32_Asynch_IO.h +++ b/ACE/ace/WIN32_Asynch_IO.h @@ -105,7 +105,7 @@ public: /// Returns 0. int signal_number (void) const; - /// Post to the Proactor's completion port. + /// Post @c this to the Proactor's completion port. int post_completion (ACE_Proactor_Impl *proactor); /// Destructor. @@ -263,7 +263,7 @@ public: /// No-op. Returns 0. int signal_number (void) const; - /// Post to the Proactor's completion port. + /// Post @c this to the Proactor's completion port. int post_completion (ACE_Proactor_Impl *proactor); /// Accessor for the scatter read flag @@ -440,7 +440,7 @@ public: /// No-op. Returns 0. int signal_number (void) const; - /// Post to the Proactor's completion port. + /// Post @c this to the Proactor's completion port. int post_completion (ACE_Proactor_Impl *proactor); /// Accessor for the gather write flag @@ -625,7 +625,7 @@ public: /// I/O handle used for reading. ACE_HANDLE handle (void) const; - /// Post to the Proactor's completion port. + /// Post @c this to the Proactor's completion port. int post_completion (ACE_Proactor_Impl *proactor); protected: @@ -836,7 +836,7 @@ public: /// I/O handle used for writing. ACE_HANDLE handle (void) const; - /// Post to the Proactor's completion port. + /// Post @c this to the Proactor's completion port. int post_completion (ACE_Proactor_Impl *proactor); protected: @@ -1033,7 +1033,7 @@ public: /// No-op. Returns 0. int signal_number (void) const; - /// Post to the Proactor's completion port. + /// Post @c this to the Proactor's completion port. int post_completion (ACE_Proactor_Impl *proactor); protected: @@ -1424,7 +1424,7 @@ public: /// No-op. Returns 0. int signal_number (void) const; - /// Post to the Proactor's completion port. + /// Post @c this to the Proactor's completion port. int post_completion (ACE_Proactor_Impl *proactor); protected: @@ -1623,7 +1623,7 @@ public: /// No-op. Returns 0. int signal_number (void) const; - /// Post to the Proactor's completion port. + /// Post @c this to the Proactor's completion port. int post_completion (ACE_Proactor_Impl *proactor); protected: @@ -1812,7 +1812,7 @@ public: /// No-op. Returns 0. int signal_number (void) const; - /// Post to the Proactor's completion port. + /// Post @c this to the Proactor's completion port. int post_completion (ACE_Proactor_Impl *proactor); protected: diff --git a/ACE/ace/config-lite.h b/ACE/ace/config-lite.h index 0ed4c1bcaac..6356f5123f5 100644 --- a/ACE/ace/config-lite.h +++ b/ACE/ace/config-lite.h @@ -58,7 +58,7 @@ extern "C" } // Signature for registering a cleanup function that is used by the -// ACE_Object_Manager and the . +// ACE_Object_Manager and the ACE_Thread_Manager. # if defined (ACE_HAS_SIG_C_FUNC) extern "C" { # endif /* ACE_HAS_SIG_C_FUNC */ -- cgit v1.2.1