summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohnny Willemsen <jwillemsen@remedy.nl>2020-04-22 09:13:33 +0200
committerGitHub <noreply@github.com>2020-04-22 09:13:33 +0200
commit5690875ec8a7728f3ab4e63a5360677b4934b4b3 (patch)
treefbf154fb835fdb664eef14cd5e5cfb68b455f7e4
parent9724ca583c8523f6095b1319ab4449f0cc110fc9 (diff)
parent340c506c5a2204289384102a0658c6e194c3194d (diff)
downloadATCD-5690875ec8a7728f3ab4e63a5360677b4934b4b3.tar.gz
Merge pull request #1083 from jwillemsen/master
Doxygen changes
-rw-r--r--ACE/ace/WFMO_Reactor.h38
1 files changed, 19 insertions, 19 deletions
diff --git a/ACE/ace/WFMO_Reactor.h b/ACE/ace/WFMO_Reactor.h
index 899c67f36d5..4d4dccd151f 100644
--- a/ACE/ace/WFMO_Reactor.h
+++ b/ACE/ace/WFMO_Reactor.h
@@ -121,7 +121,7 @@ public:
/// event
bool io_entry_;
- /// The assosiated Event_Handler
+ /// The associated Event_Handler
ACE_Event_Handler *event_handler_;
/// The I/O handle related to the Event_Handler. This entry is
@@ -430,14 +430,14 @@ public:
void dump (void) const;
protected:
- /// Reference to our <WFMO_Reactor>.
+ /// Reference to our WFMO_Reactor.
ACE_WFMO_Reactor &wfmo_reactor_;
/// Maximum number of handles.
size_t max_size_;
/**
- * Array of <ACE_HANDLEs> passed to <WaitForMultipleObjects>. This
+ * Array of ACE_HANDLEs passed to <WaitForMultipleObjects>. This
* is not part of the structure as the handle array needs to be
* passed directly to <WaitForMultipleObjects>.
*/
@@ -493,7 +493,7 @@ public:
/// Constructor
ACE_WFMO_Reactor_Notify (size_t max_notifies = 1024);
- /// Initialization. @a timer_queue is stored to call <gettimeofday>.
+ /// Initialization. @a timer_queue is stored to call gettimeofday().
virtual int open (ACE_Reactor_Impl *wfmo_reactor,
ACE_Timer_Queue *timer_queue,
int disable_notify = 0);
@@ -771,8 +771,8 @@ public:
/**
* Control whether the Reactor will handle any more incoming events or not.
- * If <do_stop> == 1, the Reactor will be disabled. By default, a reactor
- * is in active state and can be deactivated/reactived as wish.
+ * If @a do_stop == 1, the Reactor will be disabled. By default, a reactor
+ * is in active state and can be deactivated/reactivated as wish.
*/
virtual void deactivate (int do_stop);
@@ -791,13 +791,13 @@ public:
ACE_HANDLE event_handle = ACE_INVALID_HANDLE);
/**
- * Register an ACE_Event_Handler <event_handle>. @a mask specifies
- * the network events that the <event_handler> is interested in. If
- * <io_handle> == <ACE_INVALID_HANDLE> the <ACE_WFMO_Reactor> will
+ * Register an ACE_Event_Handler @a event_handle. @a mask specifies
+ * the network events that the @a event_handler is interested in. If
+ * @a io_handle == ACE_INVALID_HANDLE the ACE_WFMO_Reactor will
* call the <get_handle> method of <event_handler> to extract the
- * underlying I/O handle. If the <event_handle> ==
- * <ACE_INVALID_HANDLE>, WFMO_Reactor will create an event for
- * associating it with the I/O handle. When the <event_handle> is
+ * underlying I/O handle. If the @a event_handle ==
+ * ACE_INVALID_HANDLE, WFMO_Reactor will create an event for
+ * associating it with the I/O handle. When the @a event_handle is
* signalled, the appropriate <handle_*> callback will be invoked on
* the Event_Handler
*/
@@ -848,8 +848,8 @@ public:
ACE_Sig_Action *new_disp = 0);
/**
- * Removes @a event_handler from the <ACE_WFMO_Reactor>. Note that
- * the <ACE_WFMO_Reactor> will call the <get_handle> method of
+ * Removes @a event_handler from the ACE_WFMO_Reactor. Note that
+ * the ACE_WFMO_Reactor will call the <get_handle> method of
* @a event_handler to extract the underlying handle. If @a mask ==
* ACE_Event_Handler::DONT_CALL then the <handle_close> method of
* the @a event_handler is not invoked. Note that the @a handle can
@@ -1018,8 +1018,8 @@ public:
ACE_Reactor_Mask masks_to_be_deleted);
/**
- * Remove @a masks_to_be_deleted to the <handle>'s entry in
- * WFMO_Reactor. The Event_Handler associated with <handle> must
+ * Remove @a masks_to_be_deleted to the @a handle's entry in
+ * WFMO_Reactor. The Event_Handler associated with @a handle must
* already have been registered with WFMO_Reactor.
*/
virtual int cancel_wakeup (ACE_HANDLE handle,
@@ -1072,13 +1072,13 @@ public:
// = Assorted helper methods.
/**
- * Return the Event_Handler associated with <handle>. Return 0 if
- * <handle> is not registered.
+ * Return the Event_Handler associated with @a handle. Return 0 if
+ * @a handle is not registered.
*/
ACE_Event_Handler *find_handler (ACE_HANDLE handle);
/**
- * Check to see if <handle> is associated with a valid Event_Handler
+ * Check to see if @a handle is associated with a valid Event_Handler
* bound to @a mask. Return the @a event_handler associated with this
* @a handler if @a event_handler != 0.
*/