diff options
author | Johnny Willemsen <jwillemsen@remedy.nl> | 2009-02-03 19:46:05 +0000 |
---|---|---|
committer | Johnny Willemsen <jwillemsen@remedy.nl> | 2009-02-03 19:46:05 +0000 |
commit | 64e50d000d5e189c47416da8e542c554d33f931f (patch) | |
tree | b05363f382283b9757202be6e4ac2c8d3c599c97 | |
parent | 4b6356b8f80b8e23aeb90fa0e59f05411272dff2 (diff) | |
download | ATCD-64e50d000d5e189c47416da8e542c554d33f931f.tar.gz |
Tue Feb 3 19:45:17 UTC 2009 Johnny Willemsen <jwillemsen@remedy.nl>
* ace/Acceptor.h:
* ace/Active_Map_Manager_T.h:
* ace/CDR_Stream.h:
* ace/Configuration.h:
* ace/Connector.h:
* ace/Dev_Poll_Reactor.h:
* ace/Dirent.h:
* ace/Map_T.h:
* ace/Message_Block.h:
* ace/Message_Queue_Vx.h:
* ace/Name_Request_Reply.h:
* ace/Reactor.h:
* ace/Reactor_Impl.h:
* ace/Select_Reactor_Base.h:
* ace/Select_Reactor_T.h:
* ace/Strategies_T.h:
* ace/WFMO_Reactor.h:
Doxygen changes
* ace/Unbounded_Queue.h:
* ace/Unbounded_Queue.inl:
Use bool
-rw-r--r-- | ACE/ChangeLog | 25 | ||||
-rw-r--r-- | ACE/ace/Acceptor.h | 4 | ||||
-rw-r--r-- | ACE/ace/Active_Map_Manager_T.h | 22 | ||||
-rw-r--r-- | ACE/ace/CDR_Stream.h | 4 | ||||
-rw-r--r-- | ACE/ace/Configuration.h | 2 | ||||
-rw-r--r-- | ACE/ace/Connector.h | 4 | ||||
-rw-r--r-- | ACE/ace/Dev_Poll_Reactor.h | 12 | ||||
-rw-r--r-- | ACE/ace/Dirent.h | 6 | ||||
-rw-r--r-- | ACE/ace/Map_T.h | 6 | ||||
-rw-r--r-- | ACE/ace/Message_Block.h | 36 | ||||
-rw-r--r-- | ACE/ace/Message_Queue_Vx.h | 2 | ||||
-rw-r--r-- | ACE/ace/Name_Request_Reply.h | 2 | ||||
-rw-r--r-- | ACE/ace/Reactor.h | 4 | ||||
-rw-r--r-- | ACE/ace/Reactor_Impl.h | 32 | ||||
-rw-r--r-- | ACE/ace/Select_Reactor_Base.h | 2 | ||||
-rw-r--r-- | ACE/ace/Select_Reactor_T.h | 20 | ||||
-rw-r--r-- | ACE/ace/Strategies_T.h | 8 | ||||
-rw-r--r-- | ACE/ace/Unbounded_Queue.h | 6 | ||||
-rw-r--r-- | ACE/ace/Unbounded_Queue.inl | 6 | ||||
-rw-r--r-- | ACE/ace/WFMO_Reactor.h | 74 |
20 files changed, 150 insertions, 127 deletions
diff --git a/ACE/ChangeLog b/ACE/ChangeLog index 986b74e8ee1..40edd8493a8 100644 --- a/ACE/ChangeLog +++ b/ACE/ChangeLog @@ -1,3 +1,28 @@ +Tue Feb 3 19:45:17 UTC 2009 Johnny Willemsen <jwillemsen@remedy.nl> + + * ace/Acceptor.h: + * ace/Active_Map_Manager_T.h: + * ace/CDR_Stream.h: + * ace/Configuration.h: + * ace/Connector.h: + * ace/Dev_Poll_Reactor.h: + * ace/Dirent.h: + * ace/Map_T.h: + * ace/Message_Block.h: + * ace/Message_Queue_Vx.h: + * ace/Name_Request_Reply.h: + * ace/Reactor.h: + * ace/Reactor_Impl.h: + * ace/Select_Reactor_Base.h: + * ace/Select_Reactor_T.h: + * ace/Strategies_T.h: + * ace/WFMO_Reactor.h: + Doxygen changes + + * ace/Unbounded_Queue.h: + * ace/Unbounded_Queue.inl: + Use bool + Tue Feb 3 15:57:41 UTC 2009 Adam Mitz <mitza@ociweb.com> * tests/Logging_Strategy_Test.cpp: diff --git a/ACE/ace/Acceptor.h b/ACE/ace/Acceptor.h index 496512afd6e..499bfc38277 100644 --- a/ACE/ace/Acceptor.h +++ b/ACE/ace/Acceptor.h @@ -187,7 +187,7 @@ protected: /** * Bridge method for accepting the new connection into the - * <svc_handler>. The default behavior delegates to the + * @a svc_handler. The default behavior delegates to the * PEER_ACCEPTOR::accept. */ virtual int accept_svc_handler (SVC_HANDLER *svc_handler); @@ -293,8 +293,6 @@ public: typedef ACE_Concurrency_Strategy<SVC_HANDLER> CONCURRENCY_STRATEGY; typedef ACE_Scheduling_Strategy<SVC_HANDLER> SCHEDULING_STRATEGY; - - /// Default constructor. ACE_Strategy_Acceptor (const ACE_TCHAR service_name[] = 0, const ACE_TCHAR service_description[] = 0, diff --git a/ACE/ace/Active_Map_Manager_T.h b/ACE/ace/Active_Map_Manager_T.h index 34b5a475652..2ab3d35e1e6 100644 --- a/ACE/ace/Active_Map_Manager_T.h +++ b/ACE/ace/Active_Map_Manager_T.h @@ -53,22 +53,22 @@ public: typedef REVERSE_ITERATOR reverse_iterator; // = Initialization and termination methods. - /// Initialize a <Active_Map_Manager> with the ACE_DEFAULT_MAP_SIZE. + /// Initialize a Active_Map_Manager with the ACE_DEFAULT_MAP_SIZE. ACE_Active_Map_Manager (ACE_Allocator *alloc = 0); - /// Initialize a <Active_Map_Manager> with @a size entries. + /// Initialize a Active_Map_Manager with @a size entries. ACE_Active_Map_Manager (size_t size, ACE_Allocator *alloc = 0); - /// Close down a <Active_Map_Manager> and release dynamically + /// Close down a Active_Map_Manager and release dynamically /// allocated resources. ~ACE_Active_Map_Manager (void); - /// Initialize a <Active_Map_Manager> with size @a length. + /// Initialize a Active_Map_Manager with size @a length. int open (size_t length = ACE_DEFAULT_MAP_SIZE, ACE_Allocator *alloc = 0); - /// Close down a <Active_Map_Manager> and release dynamically + /// Close down a Active_Map_Manager and release dynamically /// allocated resources. int close (void); @@ -84,8 +84,8 @@ public: /** * Reserves a slot in the internal structure and returns the key and * a pointer to the value. User should place their @a value into - * <*internal_value>. This method is useful in reducing the number - * of copies required in some cases. Note that <internal_value> is + * @a internal_value. This method is useful in reducing the number + * of copies required in some cases. Note that @a internal_value is * only a temporary pointer and will change when the map resizes. * Therefore, the user should use the pointer immediately and not * hold on to it. @@ -126,8 +126,8 @@ public: /** * Locate @a value associated with @a key. The value is returned via - * <internal_value> and hence a copy is saved. Note that - * <internal_value> is only a temporary pointer and will change when + * @a internal_value and hence a copy is saved. Note that + * @a internal_value is only a temporary pointer and will change when * the map resizes. Therefore, the user should use the pointer * immediately and not hold on to it. */ @@ -148,8 +148,8 @@ public: /** * Locate @a value associated with @a key. The value is returned via - * <internal_value> and hence a copy is saved. Note that - * <internal_value> is only a temporary pointer and will change when + * @a internal_value and hence a copy is saved. Note that + * @a internal_value is only a temporary pointer and will change when * the map resizes or when this slot is reused. Therefore, the user * should use the pointer immediately and not hold on to it. */ diff --git a/ACE/ace/CDR_Stream.h b/ACE/ace/CDR_Stream.h index e4d666caafd..fac230d7373 100644 --- a/ACE/ace/CDR_Stream.h +++ b/ACE/ace/CDR_Stream.h @@ -254,8 +254,8 @@ public: const ACE_CDR::WChar *x); //@} - /// @note the portion written starts at <x> and ends - /// at <x + length>. + /// @note the portion written starts at @a x and ends + /// at @a x + @a length. /// The length is *NOT* stored into the CDR stream. //@{ @name Array write operations ACE_CDR::Boolean write_boolean_array (const ACE_CDR::Boolean *x, diff --git a/ACE/ace/Configuration.h b/ACE/ace/Configuration.h index 500eb3c1df2..5126aeed622 100644 --- a/ACE/ace/Configuration.h +++ b/ACE/ace/Configuration.h @@ -598,7 +598,7 @@ public: /// allocator name_ was created in void free (ACE_Allocator *alloc); - /// <hash> function is required in order for this class to be usable by + /// hash function is required in order for this class to be usable by /// ACE_Hash_Map_Manager. u_long hash (void) const; diff --git a/ACE/ace/Connector.h b/ACE/ace/Connector.h index 0b92d55efcd..4ba8c7ce3dd 100644 --- a/ACE/ace/Connector.h +++ b/ACE/ace/Connector.h @@ -190,7 +190,7 @@ public: * 1). @a flags and @a perms can be used to pass any flags that are * needed to perform specific operations such as opening a file * within connect with certain permissions. If the connection fails - * the <close> hook on the <svc_handler> will be called + * the <close> hook on the @a svc_handler will be called * automatically to prevent resource leaks. */ virtual int connect (SVC_HANDLER *&svc_handler, @@ -209,7 +209,7 @@ public: * context of the internal cache its use is thread-safe. But the * actual svc_handler for the current connection is returned in the * second parameter @a svc_handler. If the connection fails the - * <close> hook on the <svc_handler> will be called automatically to + * <close> hook on the @a svc_handler will be called automatically to * prevent resource leaks. */ virtual int connect (SVC_HANDLER *&svc_handler_hint, diff --git a/ACE/ace/Dev_Poll_Reactor.h b/ACE/ace/Dev_Poll_Reactor.h index dd9a16d6cee..f991111642d 100644 --- a/ACE/ace/Dev_Poll_Reactor.h +++ b/ACE/ace/Dev_Poll_Reactor.h @@ -622,8 +622,8 @@ public: ACE_Event_Handler **old_sh = 0, ACE_Sig_Action *old_disp = 0); - /// Registers <new_sh> to handle a set of signals <sigset> using the - /// <new_disp>. + /// Registers @a new_sh to handle a set of signals @a sigset using the + /// @a new_disp. virtual int register_handler (const ACE_Sig_Set &sigset, ACE_Event_Handler *new_sh, ACE_Sig_Action *new_disp = 0); @@ -647,7 +647,7 @@ public: ACE_Reactor_Mask mask); /** - * Removes all handles in <handle_set>. If @a mask == + * Removes all handles in @a handle_set. If @a mask == * ACE_Event_Handler::DONT_CALL then the <handle_close> method of * the associated <event_handler>s is not invoked. */ @@ -665,7 +665,7 @@ public: ACE_Sig_Action *old_disp = 0, int sigkey = -1); - /// Calls <remove_handler> for every signal in <sigset>. + /// Calls <remove_handler> for every signal in @a sigset. virtual int remove_handler (const ACE_Sig_Set &sigset); // = Suspend and resume Handlers. @@ -793,7 +793,7 @@ public: /** * Set the maximum number of times that ACE_Reactor_Impl will - * iterate and dispatch the <ACE_Event_Handlers> that are passed in + * iterate and dispatch the ACE_Event_Handlers that are passed in * via the notify queue before breaking out of its * <ACE_Message_Queue::dequeue> loop. By default, this is set to * -1, which means "iterate until the queue is empty." Setting this @@ -805,7 +805,7 @@ public: /** * Get the maximum number of times that the ACE_Reactor_Impl will - * iterate and dispatch the <ACE_Event_Handlers> that are passed in + * iterate and dispatch the ACE_Event_Handlers that are passed in * via the notify queue before breaking out of its * <ACE_Message_Queue::dequeue> loop. */ diff --git a/ACE/ace/Dirent.h b/ACE/ace/Dirent.h index 823b28d747c..17557f46fc5 100644 --- a/ACE/ace/Dirent.h +++ b/ACE/ace/Dirent.h @@ -39,17 +39,17 @@ public: /// Default constructor. ACE_Dirent (void); - /// Constructor calls <opendir> + /// Constructor calls @c opendir() explicit ACE_Dirent (const ACE_TCHAR *dirname); /// Opens the directory named by filename and associates a directory /// stream with it. int open (const ACE_TCHAR *filename); - /// Destructor calls <closedir>. + /// Destructor calls @c closedir(). ~ACE_Dirent (void); - /// Closes the directory stream and frees the <ACE_DIR> structure. + /// Closes the directory stream and frees the ACE_DIR structure. void close (void); // = Iterator methods. diff --git a/ACE/ace/Map_T.h b/ACE/ace/Map_T.h index 142d07803ce..a552e0f6d48 100644 --- a/ACE/ace/Map_T.h +++ b/ACE/ace/Map_T.h @@ -1145,11 +1145,11 @@ public: /// Close down and release dynamically allocated resources. virtual ~ACE_Hash_Map_Manager_Ex_Adapter (void); - /// Initialize a <Map> with size @a length. + /// Initialize a Map with size @a length. virtual int open (size_t length = ACE_DEFAULT_MAP_SIZE, ACE_Allocator *alloc = 0); - /// Close down a <Map> and release dynamically allocated resources. + /// Close down a Map and release dynamically allocated resources. virtual int close (void); /** @@ -1204,7 +1204,7 @@ public: virtual int bind_create_key (const VALUE &value); /// Recovers the original key potentially modified by the map during - /// <bind_modify_key>. + /// bind_modify_key(). virtual int recover_key (const KEY &modified_key, KEY &original_key); diff --git a/ACE/ace/Message_Block.h b/ACE/ace/Message_Block.h index 00d7dfe5b2c..535f6858113 100644 --- a/ACE/ace/Message_Block.h +++ b/ACE/ace/Message_Block.h @@ -214,14 +214,14 @@ public: /** * Create an initialized message of type @a type containing @a size * bytes. The @a cont argument initializes the continuation field in - * the <Message_Block>. If @a data == 0 then we create and own the + * the Message_Block. If @a data == 0 then we create and own the * @a data, using @a allocator_strategy to get the data if it's non-0. If * @a data != 0 we assume that we have ownership of the @a data till * this object ceases to exist (and don't delete it during * destruction). If @a locking_strategy is non-0 then this is used * to protect regions of code that access shared state (e.g., * reference counting) from race conditions. Note that the @a size - * of the <Message_Block> will be @a size, but the @a length will be 0 + * of the Message_Block will be @a size, but the @a length will be 0 * until <wr_ptr> is set. The @a data_block_allocator is use to * allocate the data blocks while the @a allocator_strategy is used * to allocate the buffers contained by those. @@ -393,7 +393,7 @@ public: */ int copy (const char *buf); - /// Normalizes data in the top-level <Message_Block> to align with the base, + /// Normalizes data in the top-level Message_Block to align with the base, /// i.e., it "shifts" the data pointed to by <rd_ptr> down to the <base> and /// then readjusts <rd_ptr> to point to <base> and <wr_ptr> to point /// to <base> + the length of the moved data. Returns -1 and does @@ -405,7 +405,7 @@ public: void reset (void); /// Access all the allocators in the message block. - /// @@todo: Not sure whether we would need finer control while + /// @todo Not sure whether we would need finer control while /// trying to access allocators ie. a method for every allocator. /** * This method returns the allocators only from the first message @@ -486,40 +486,40 @@ public: /// Set the length of the message void length (size_t n); - /// Get the length of the <Message_Block>s, including chained - /// <Message_Block>s. + /// Get the length of the Message_Blocks, including chained + /// Message_Blocks. size_t total_length (void) const; - /// Get the total number of bytes in all <Message_Block>s, including - /// chained <Message_Block>s. + /// Get the total number of bytes in all Message_Blocks, including + /// chained Message_Blocks. size_t total_size (void) const; /// Get the total number of bytes and total length in all - /// <Message_Block>s, including chained <Message_Block>s. + /// Message_Blocks, including chained Message_Blocks. void total_size_and_length (size_t &mb_size, size_t &mb_length) const; - /// Get the number of bytes in the top-level <Message_Block> (i.e., - /// does not consider the bytes in chained <Message_Block>s). + /// Get the number of bytes in the top-level Message_Block (i.e., + /// does not consider the bytes in chained Message_Blocks). size_t size (void) const; /** - * Set the number of bytes in the top-level <Message_Block>, + * Set the number of bytes in the top-level Message_Block, * reallocating space if necessary. However, the <rd_ptr_> and * <wr_ptr_> remain at the original offsets into the buffer, even if * it is reallocated. Returns 0 if successful, else -1. */ int size (size_t length); - /// Get the number of allocated bytes in all <Message_Block>, including - /// chained <Message_Block>s. + /// Get the number of allocated bytes in all Message_Block, including + /// chained Message_Blocks. size_t total_capacity (void) const; - /// Get the number of allocated bytes in the top-level <Message_Block>. + /// Get the number of allocated bytes in the top-level Message_Block. size_t capacity (void) const; /// Get the number of bytes available after the <wr_ptr_> in the - /// top-level <Message_Block>. + /// top-level Message_Block. size_t space (void) const; //@} @@ -552,14 +552,14 @@ public: /// Set the continuation field. void cont (ACE_Message_Block *); - // = Pointer to the <Message_Block> directly ahead in the ACE_Message_Queue. + // = Pointer to the Message_Block directly ahead in the ACE_Message_Queue. /// Get link to next message. ACE_Message_Block *next (void) const; /// Set link to next message. void next (ACE_Message_Block *); - // = Pointer to the <Message_Block> directly behind in the ACE_Message_Queue. + // = Pointer to the Message_Block directly behind in the ACE_Message_Queue. /// Get link to prev message. ACE_Message_Block *prev (void) const; diff --git a/ACE/ace/Message_Queue_Vx.h b/ACE/ace/Message_Queue_Vx.h index 421ebce99ea..418e8cce183 100644 --- a/ACE/ace/Message_Queue_Vx.h +++ b/ACE/ace/Message_Queue_Vx.h @@ -58,7 +58,7 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL * * <peek_dequeue_head>. * * <ACE_Message_Queue_Iterators>. * * The ability to change low and high water marks after creation. - * * <Message_Block> chains. The continuation field of ACE_Message_Block + * * Message_Block chains. The continuation field of ACE_Message_Block * * is ignored; only the first block of a fragment chain is * * recognized. */ diff --git a/ACE/ace/Name_Request_Reply.h b/ACE/ace/Name_Request_Reply.h index 3a927e9f9e3..a3b70309944 100644 --- a/ACE/ace/Name_Request_Reply.h +++ b/ACE/ace/Name_Request_Reply.h @@ -205,7 +205,7 @@ public: /// Default constructor. ACE_Name_Reply (void); - /// Create a <ACE_Name_Reply> message. + /// Create a ACE_Name_Reply message. ACE_Name_Reply (ACE_UINT32 type, ACE_UINT32 err); // Type of reply. /// Initialize length_ in order to ensure correct byte ordering diff --git a/ACE/ace/Reactor.h b/ACE/ace/Reactor.h index 423c736bbbb..a791a65227d 100644 --- a/ACE/ace/Reactor.h +++ b/ACE/ace/Reactor.h @@ -380,7 +380,7 @@ public: * Shorthand for calling * register_handler(ACE_HANDLE,ACE_Event_Handler*,ACE_Reactor_Mask), * multiple times for the same @a event_handler and @a masks but - * different <handles>. + * different @a handles. */ int register_handler (const ACE_Handle_Set &handles, ACE_Event_Handler *event_handler, @@ -524,7 +524,7 @@ public: * Resume @a handles. * * Shorthand for calling resume_handler(ACE_HANDLE) with multiple - * <handles>. + * @a handles. */ int resume_handler (const ACE_Handle_Set &handles); diff --git a/ACE/ace/Reactor_Impl.h b/ACE/ace/Reactor_Impl.h index feddde8ad51..18a82034e3a 100644 --- a/ACE/ace/Reactor_Impl.h +++ b/ACE/ace/Reactor_Impl.h @@ -91,7 +91,7 @@ public: ACE_Notification_Buffer &buffer) = 0; /** * Set the maximum number of times that the <handle_input> method - * will iterate and dispatch the <ACE_Event_Handlers> that are + * will iterate and dispatch the ACE_Event_Handlers that are * passed in via the notify queue before breaking out of the event * loop. By default, this is set to -1, which means "iterate until * the queue is empty." Setting this to a value like "1 or 2" will @@ -102,7 +102,7 @@ public: /** * Get the maximum number of times that the <handle_input> method - * will iterate and dispatch the <ACE_Event_Handlers> that are + * will iterate and dispatch the ACE_Event_Handlers that are * passed in via the notify queue before breaking out of its event * loop. */ @@ -263,15 +263,15 @@ public: ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask) = 0; - /// Register @a event_handler with all the <handles> in the <Handle_Set>. + /// Register @a event_handler with all the @a handles in the <Handle_Set>. virtual int register_handler (const ACE_Handle_Set &handles, ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask) = 0; /** - * Register <new_sh> to handle the signal @a signum using the - * <new_disp>. Returns the <old_sh> that was previously registered - * (if any), along with the <old_disp> of the signal handler. + * Register @a new_sh to handle the signal @a signum using the + * @a new_disp. Returns the @a old_sh that was previously registered + * (if any), along with the @a old_disp of the signal handler. */ virtual int register_handler (int signum, ACE_Event_Handler *new_sh, @@ -279,8 +279,8 @@ public: ACE_Event_Handler **old_sh = 0, ACE_Sig_Action *old_disp = 0) = 0; - /// Registers <new_sh> to handle a set of signals <sigset> using the - /// <new_disp>. + /// Registers @a new_sh to handle a set of signals @a sigset using the + /// @a new_disp. virtual int register_handler (const ACE_Sig_Set &sigset, ACE_Event_Handler *new_sh, ACE_Sig_Action *new_disp = 0) = 0; @@ -303,7 +303,7 @@ public: ACE_Reactor_Mask mask) = 0; /** - * Removes all handles in <handle_set>. If @a mask == + * Removes all handles in @a handle_set. If @a mask == * ACE_Event_Handler::DONT_CALL then the <handle_close> method of * the associated <event_handler>s is not invoked. */ @@ -321,7 +321,7 @@ public: ACE_Sig_Action *old_disp = 0, int sigkey = -1) = 0; - /// Calls <remove_handler> for every signal in <sigset>. + /// Calls <remove_handler> for every signal in @a sigset. virtual int remove_handler (const ACE_Sig_Set &sigset) = 0; // = Suspend and resume Handlers. @@ -333,7 +333,7 @@ public: /// Suspend @a handle temporarily. virtual int suspend_handler (ACE_HANDLE handle) = 0; - /// Suspend all <handles> in handle set temporarily. + /// Suspend all @a handles in handle set temporarily. virtual int suspend_handler (const ACE_Handle_Set &handles) = 0; /// Suspend all <handles> temporarily. @@ -346,7 +346,7 @@ public: /// Resume @a handle. virtual int resume_handler (ACE_HANDLE handle) = 0; - /// Resume all <handles> in handle set. + /// Resume all @a handles in handle set. virtual int resume_handler (const ACE_Handle_Set &handles) = 0; /// Resume all <handles>. @@ -427,7 +427,7 @@ public: virtual int schedule_wakeup (ACE_HANDLE handle, ACE_Reactor_Mask masks_to_be_added) = 0; - /// Clear @a masks_to_be_cleared from the <event_handler>'s entry. + /// Clear @a masks_to_be_cleared from the @a event_handler's entry. virtual int cancel_wakeup (ACE_Event_Handler *event_handler, ACE_Reactor_Mask masks_to_be_cleared) = 0; @@ -449,7 +449,7 @@ public: /** * Set the maximum number of times that ACE_Reactor_Impl will - * iterate and dispatch the <ACE_Event_Handlers> that are passed in + * iterate and dispatch the ACE_Event_Handlers that are passed in * via the notify queue before breaking out of its * <ACE_Message_Queue::dequeue> loop. By default, this is set to * -1, which means "iterate until the queue is empty." Setting this @@ -461,7 +461,7 @@ public: /** * Get the maximum number of times that the ACE_Reactor_Impl will - * iterate and dispatch the <ACE_Event_Handlers> that are passed in + * iterate and dispatch the ACE_Event_Handlers that are passed in * via the notify queue before breaking out of its * <ACE_Message_Queue::dequeue> loop. */ @@ -512,7 +512,7 @@ public: /// Wake up all threads in waiting in the event loop virtual void wakeup_all_threads (void) = 0; - /// Transfers ownership of Reactor_Impl to the <new_owner>. + /// Transfers ownership of Reactor_Impl to the @a new_owner. virtual int owner (ACE_thread_t new_owner, ACE_thread_t *old_owner = 0) = 0; /// Return the ID of the "owner" thread. diff --git a/ACE/ace/Select_Reactor_Base.h b/ACE/ace/Select_Reactor_Base.h index b8f86fa7d32..eafb19b0b8c 100644 --- a/ACE/ace/Select_Reactor_Base.h +++ b/ACE/ace/Select_Reactor_Base.h @@ -570,7 +570,7 @@ protected: /** * True if state has changed during dispatching of - * <ACE_Event_Handlers>, else false. This is used to determine + * ACE_Event_Handlers, else false. This is used to determine * whether we need to make another trip through the * <Select_Reactor>'s <wait_for_multiple_events> loop. */ diff --git a/ACE/ace/Select_Reactor_T.h b/ACE/ace/Select_Reactor_T.h index 458f7ebac73..526db0fd9f6 100644 --- a/ACE/ace/Select_Reactor_T.h +++ b/ACE/ace/Select_Reactor_T.h @@ -279,7 +279,7 @@ public: ACE_Reactor_Mask); /** - * Removes all the @a mask bindings for handles in the <handle_set> + * Removes all the @a mask bindings for handles in the @a handle_set * bind of <Event_Handler>. If there are no more bindings for any * of these handlers then they are removed from the Select_Reactor. */ @@ -298,7 +298,7 @@ public: ACE_Sig_Action *old_disp = 0, int sigkey = -1); - /// Calls <remove_handler> for every signal in <sigset>. + /// Calls <remove_handler> for every signal in @a sigset. virtual int remove_handler (const ACE_Sig_Set &sigset); // = Suspend and resume Handlers. @@ -309,7 +309,7 @@ public: /// Temporarily suspend the <Event_Handler> associated with @a handle. virtual int suspend_handler (ACE_HANDLE handle); - /// Suspend all <handles> in handle set temporarily. + /// Suspend all @a handles in handle set temporarily. virtual int suspend_handler (const ACE_Handle_Set &handles); /// Suspend all the <Event_Handlers> in the Select_Reactor. @@ -323,7 +323,7 @@ public: /// @a handle. virtual int resume_handler (ACE_HANDLE handle); - /// Resume all <handles> in handle set. + /// Resume all @a handles in handle set. virtual int resume_handler (const ACE_Handle_Set &handles); /// Resume all the <Event_Handlers> in the Select_Reactor. @@ -373,8 +373,8 @@ public: /** * Cancel all <event_handlers> that match the address of - * <event_handler>. If @a dont_call_handle_close is 0 then the - * <handle_close> method of <event_handler> will be invoked. + * @a event_handler. If @a dont_call_handle_close is 0 then the + * <handle_close> method of @a event_handler will be invoked. * Returns number of handler's cancelled. */ virtual int cancel_timer (ACE_Event_Handler *event_handler, @@ -431,7 +431,7 @@ public: /** * Set the maximum number of times that the * <ACE_Select_Reactor_Notify::handle_input> method will iterate and - * dispatch the <ACE_Event_Handlers> that are passed in via the + * dispatch the ACE_Event_Handlers that are passed in via the * notify pipe before breaking out of its <recv> loop. By default, * this is set to -1, which means "iterate until the pipe is empty." * Setting this to a value like "1 or 2" will increase "fairness" @@ -443,7 +443,7 @@ public: /** * Get the maximum number of times that the * <ACE_Select_Reactor_Notify::handle_input> method will iterate and - * dispatch the <ACE_Event_Handlers> that are passed in via the + * dispatch the ACE_Event_Handlers that are passed in via the * notify pipe before breaking out of its <recv> loop. */ virtual int max_notify_iterations (void); @@ -556,7 +556,7 @@ protected: ACE_Event_Handler *eh, ACE_Reactor_Mask mask); - /// Register a set of <handles>. + /// Register a set of @a handles. virtual int register_handler_i (const ACE_Handle_Set &handles, ACE_Event_Handler *handler, ACE_Reactor_Mask mask); @@ -566,7 +566,7 @@ protected: virtual int remove_handler_i (ACE_HANDLE handle, ACE_Reactor_Mask); - /// Remove a set of <handles>. + /// Remove a set of @a handles. virtual int remove_handler_i (const ACE_Handle_Set &handles, ACE_Reactor_Mask); diff --git a/ACE/ace/Strategies_T.h b/ACE/ace/Strategies_T.h index 2dd8c2fd543..1318f27fe5d 100644 --- a/ACE/ace/Strategies_T.h +++ b/ACE/ace/Strategies_T.h @@ -107,7 +107,7 @@ public: /** * Create a SVC_HANDLER with the appropriate creation strategy. The * default behavior of this method is to make a new SVC_HANDLER if - * @a sh == 0 (passing in the <Thread_Manager>), else @a sh is + * @a sh == 0 (passing in the Thread_Manager), else @a sh is * unchanged. Returns -1 on failure, else 0. */ virtual int make_svc_handler (SVC_HANDLER *&sh); @@ -262,7 +262,7 @@ public: // = Factory method. /** - * Activate the <svc_handler> with an appropriate concurrency + * Activate the @a svc_handler with an appropriate concurrency * strategy. The default behavior of this method is to activate the * SVC_HANDLER by calling its <open> method (which allows the * SVC_HANDLER to define its own concurrency strategy). @@ -321,7 +321,7 @@ public: virtual ~ACE_Reactive_Strategy (void); // = Factory method. - /// Activate the <svc_handler> by registering it with the <Reactor> + /// Activate the @a svc_handler by registering it with the <Reactor> /// and then calling it's <open> hook. virtual int activate_svc_handler (SVC_HANDLER *svc_handler, void *arg = 0); @@ -875,7 +875,7 @@ public: /// Template method for making a new <svc_handler> virtual int make_svc_handler (SVC_HANDLER *&sh); - /// Template method for activating a new <svc_handler> + /// Template method for activating a new @a svc_handler virtual int activate_svc_handler (SVC_HANDLER *svc_handler); /// Template method for setting the recycler information of the diff --git a/ACE/ace/Unbounded_Queue.h b/ACE/ace/Unbounded_Queue.h index ae70125ffbd..3a750b0302d 100644 --- a/ACE/ace/Unbounded_Queue.h +++ b/ACE/ace/Unbounded_Queue.h @@ -185,17 +185,17 @@ public: // = Check boundary conditions. - /// Returns 1 if the container is empty, otherwise returns 0. + /// Returns true if the container is empty, otherwise returns false. /** * Constant time check to see if the queue is empty. */ - int is_empty (void) const; + bool is_empty (void) const; /// Returns 0. /** * The queue cannot be full, so it always returns 0. */ - int is_full (void) const; + bool is_full (void) const; // = Classic queue operations. diff --git a/ACE/ace/Unbounded_Queue.inl b/ACE/ace/Unbounded_Queue.inl index 35bb7fb9cdf..b7d814e9780 100644 --- a/ACE/ace/Unbounded_Queue.inl +++ b/ACE/ace/Unbounded_Queue.inl @@ -10,18 +10,18 @@ ACE_Unbounded_Queue<T>::size (void) const return this->cur_size_; } -template <class T> ACE_INLINE int +template <class T> ACE_INLINE bool ACE_Unbounded_Queue<T>::is_empty (void) const { // ACE_TRACE ("ACE_Unbounded_Queue<T>::is_empty"); return this->head_ == this->head_->next_; } -template <class T> ACE_INLINE int +template <class T> ACE_INLINE bool ACE_Unbounded_Queue<T>::is_full (void) const { // ACE_TRACE ("ACE_Unbounded_Queue<T>::is_full"); - return 0; // We should implement a "node of last resort for this..." + return false; // We should implement a "node of last resort for this..." } ACE_END_VERSIONED_NAMESPACE_DECL diff --git a/ACE/ace/WFMO_Reactor.h b/ACE/ace/WFMO_Reactor.h index a0ad4c95d4b..7731da3c942 100644 --- a/ACE/ace/WFMO_Reactor.h +++ b/ACE/ace/WFMO_Reactor.h @@ -419,8 +419,8 @@ public: /** * Check to see if @a handle is associated with a valid Event_Handler - * bound to @a mask. Return the <event_handler> associated with this - * @a handler if <event_handler> != 0. + * bound to @a mask. Return the @a event_handler associated with this + * @a handler if @a event_handler != 0. */ int handler (ACE_HANDLE handle, ACE_Reactor_Mask mask, @@ -510,7 +510,7 @@ public: /** * Special trick to unblock <WaitForMultipleObjects> when updates - * occur. All we do is enqueue <event_handler> and @a mask onto the + * occur. All we do is enqueue @a event_handler and @a mask onto the * ACE_Message_Queue and wakeup the <WFMO_Reactor> by signaling * its <ACE_Event> handle. The ACE_Time_Value indicates how long * to blocking trying to notify the <WFMO_Reactor>. If @a timeout == @@ -549,7 +549,7 @@ public: /** * Set the maximum number of times that the * <ACE_WFMO_Reactor_Notify::handle_input> method will iterate and - * dispatch the <ACE_Event_Handlers> that are passed in via the + * dispatch the ACE_Event_Handlers that are passed in via the * notify queue before breaking out of its * <ACE_Message_Queue::dequeue> loop. By default, this is set to * -1, which means "iterate until the queue is empty." Setting this @@ -562,7 +562,7 @@ public: /** * Get the maximum number of times that the * <ACE_WFMO_Reactor_Notify::handle_input> method will iterate and - * dispatch the <ACE_Event_Handlers> that are passed in via the + * dispatch the ACE_Event_Handlers that are passed in via the * notify queue before breaking out of its * <ACE_Message_Queue::dequeue> loop. */ @@ -588,7 +588,7 @@ private: /** * Called when the notification event waited on by * <ACE_WFMO_Reactor> is signaled. This dequeues all pending - * <ACE_Event_Handlers> and dispatches them. + * ACE_Event_Handlers and dispatches them. */ virtual int handle_signal (int signum, siginfo_t * = 0, ucontext_t * = 0); @@ -596,7 +596,7 @@ private: /// thread up (e.g., when the <notify> method is called). ACE_Auto_Event wakeup_one_thread_; - /// Message queue that keeps track of pending <ACE_Event_Handlers>. + /// Message queue that keeps track of pending ACE_Event_Handlers. /// This queue must be thread-safe because it can be called by /// multiple threads of control. ACE_Message_Queue<ACE_MT_SYNCH> message_queue_; @@ -604,7 +604,7 @@ private: /** * Keeps track of the maximum number of times that the * <ACE_WFMO_Reactor_Notify::handle_input> method will iterate and - * dispatch the <ACE_Event_Handlers> that are passed in via the + * dispatch the ACE_Event_Handlers that are passed in via the * notify queue before breaking out of its * <ACE_Message_Queue::dequeue> loop. By default, this is set to * -1, which means "iterate until the queue is empty." @@ -788,13 +788,13 @@ public: // = Register and remove Handlers. /** - * Register an ACE_Event_Handler <event_handler>. Since no Event + * Register an ACE_Event_Handler @a event_handler. Since no Event * Mask is passed through this interface, it is assumed that the * @a handle being passed in is an event handle and when the event * becomes signaled, <WFMO_Reactor> will call handle_signal on - * <event_handler>. If @a handle == <ACE_INVALID_HANDLE> the + * @a event_handler. If @a handle == <ACE_INVALID_HANDLE> the * <ACE_WFMO_Reactor> will call the <get_handle> method of - * <event_handler> to extract the underlying event handle. + * @a event_handler to extract the underlying event handle. */ virtual int register_handler (ACE_Event_Handler *event_handler, ACE_HANDLE event_handle = ACE_INVALID_HANDLE); @@ -833,16 +833,16 @@ public: virtual int register_handler (ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask); - /// Register <event_handler> with all the <handles> in the + /// Register @a event_handler with all the @a handles in the /// <Handle_Set>. virtual int register_handler (const ACE_Handle_Set &handles, ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask); /** - * Register <new_sh> to handle the signal @a signum using the - * <new_disp>. Returns the <old_sh> that was previously registered - * (if any), along with the <old_disp> of the signal handler. + * Register @a new_sh to handle the signal @a signum using the + * @a new_disp. Returns the @a old_sh that was previously registered + * (if any), along with the @a old_disp of the signal handler. */ virtual int register_handler (int signum, ACE_Event_Handler *new_sh, @@ -850,18 +850,18 @@ public: ACE_Event_Handler **old_sh = 0, ACE_Sig_Action *old_disp = 0); - /// Registers <new_sh> to handle a set of signals <sigset> using the - /// <new_disp>. + /// Registers @a new_sh to handle a set of signals @a sigset using the + /// @a new_disp. virtual int register_handler (const ACE_Sig_Set &sigset, ACE_Event_Handler *new_sh, ACE_Sig_Action *new_disp = 0); /** - * Removes <event_handler> from the <ACE_WFMO_Reactor>. Note that + * Removes @a event_handler from the <ACE_WFMO_Reactor>. Note that * the <ACE_WFMO_Reactor> will call the <get_handle> method of - * <event_handler> to extract the underlying handle. If @a mask == + * @a event_handler to extract the underlying handle. If @a mask == * ACE_Event_Handler::DONT_CALL then the <handle_close> method of - * the <event_handler> is not invoked. Note that the @a handle can + * the @a event_handler is not invoked. Note that the @a handle can * either be the <event_handle> or the <io_handle> */ virtual int remove_handler (ACE_Event_Handler *event_handler, @@ -884,7 +884,7 @@ public: ACE_Reactor_Mask mask); /** - * Removes all the @a mask bindings for handles in the <handle_set> + * Removes all the @a mask bindings for handles in the @a handle_set * bind of <Event_Handler>. If there are no more bindings for any * of these handles then they are removed from WFMO_Reactor. */ @@ -903,32 +903,32 @@ public: ACE_Sig_Action *old_disp = 0, int sigkey = -1); - /// Calls <remove_handler> for every signal in <sigset>. + /// Calls <remove_handler> for every signal in @a sigset. virtual int remove_handler (const ACE_Sig_Set &sigset); // = Suspend and resume Handlers. - /// Suspend <event_handler> temporarily. Use + /// Suspend @a event_handler temporarily. Use /// <ACE_Event_Handler::get_handle> to get the handle. virtual int suspend_handler (ACE_Event_Handler *event_handler); /// Suspend @a handle temporarily. virtual int suspend_handler (ACE_HANDLE handle); - /// Suspend all <handles> in handle set temporarily. + /// Suspend all @a handles in handle set temporarily. virtual int suspend_handler (const ACE_Handle_Set &handles); /// Suspend all <handles> temporarily. virtual int suspend_handlers (void); - /// Resume <event_handler>. Use <ACE_Event_Handler::get_handle> to + /// Resume @a event_handler. Use <ACE_Event_Handler::get_handle> to /// get the handle. virtual int resume_handler (ACE_Event_Handler *event_handler); /// Resume @a handle. virtual int resume_handler (ACE_HANDLE handle); - /// Resume all <handles> in handle set. + /// Resume all @a handles in handle set. virtual int resume_handler (const ACE_Handle_Set &handles); /// Resume all <handles>. @@ -983,7 +983,7 @@ public: const ACE_Time_Value &interval); /// Cancel all Event_Handlers that match the address of - /// <event_handler>. Returns number of handler's cancelled. + /// @a event_handler. Returns number of handler's cancelled. virtual int cancel_timer (ACE_Event_Handler *event_handler, int dont_call_handle_close = 1); @@ -1003,8 +1003,8 @@ public: // = High-level Event_Handler scheduling operations /** - * Add @a masks_to_be_added to the <event_handler>'s entry in - * WFMO_Reactor. <event_handler> must already have been registered + * Add @a masks_to_be_added to the @a event_handler's entry in + * WFMO_Reactor. @a event_handler must already have been registered * with WFMO_Reactor. */ virtual int schedule_wakeup (ACE_Event_Handler *event_handler, @@ -1051,7 +1051,7 @@ public: /** * Set the maximum number of times that the * <ACE_WFMO_Reactor_Notify::handle_input> method will iterate and - * dispatch the <ACE_Event_Handlers> that are passed in via the + * dispatch the ACE_Event_Handlers that are passed in via the * notify queue before breaking out of its * <ACE_Message_Queue::dequeue> loop. By default, this is set to * -1, which means "iterate until the queue is empty." Setting this @@ -1064,7 +1064,7 @@ public: /** * Get the maximum number of times that the * <ACE_WFMO_Reactor_Notify::handle_input> method will iterate and - * dispatch the <ACE_Event_Handlers> that are passed in via the + * dispatch the ACE_Event_Handlers that are passed in via the * notify queue before breaking out of its * <ACE_Message_Queue::dequeue> loop. */ @@ -1088,8 +1088,8 @@ public: /** * Check to see if <handle> is associated with a valid Event_Handler - * bound to @a mask. Return the <event_handler> associated with this - * @a handler if <event_handler> != 0. + * bound to @a mask. Return the @a event_handler associated with this + * @a handler if @a event_handler != 0. */ virtual int handler (ACE_HANDLE handle, ACE_Reactor_Mask mask, @@ -1119,7 +1119,7 @@ public: virtual void wakeup_all_threads (void); /** - * Transfers ownership of the WFMO_Reactor to the <new_owner>. The + * Transfers ownership of the WFMO_Reactor to the @a new_owner. The * transfer will not complete until all threads are ready (just like * the handle set). */ @@ -1143,8 +1143,8 @@ public: // = Low-level wait_set mask manipulation methods. /** - * Modify @a masks of the <event_handler>'s entry in WFMO_Reactor - * depending upon <operation>. <event_handler> must already have + * Modify @a masks of the @a event_handler's entry in WFMO_Reactor + * depending upon <operation>. @a event_handler must already have * been registered with WFMO_Reactor. */ virtual int mask_ops (ACE_Event_Handler *event_handler, @@ -1308,7 +1308,7 @@ protected: /** * A manual event is used so that we can wake everyone up (e.g., - * when <ACE_Event_Handlers> are bounded and unbound from the + * when ACE_Event_Handlers are bounded and unbound from the * handler repository). */ ACE_Manual_Event wakeup_all_threads_; |