Doxygen improvements

    * ACE/ace/Reactor_Impl.h:

1 files changed, 35 insertions, 35 deletions

diff --git a/ACE/ace/Reactor_Impl.h b/ACE/ace/Reactor_Impl.h
index 44d5d55afd5..dd02f9857b9 100644
--- a/ACE/ace/Reactor_Impl.h
+++ b/ACE/ace/Reactor_Impl.h
@@ -52,12 +52,12 @@ public:
   virtual int close (void) = 0;
 
   /**
-   * Called by a thread when it wants to unblock the <Reactor_Impl>.
-   * This wakeups the <Reactor_Impl> if currently blocked.  Pass over
-   * both the <Event_Handler> *and* the @a mask to allow the caller to
-   * dictate which <Event_Handler> method the <Reactor_Impl> will
+   * Called by a thread when it wants to unblock the Reactor_Impl.
+   * This wakeups the Reactor_Impl if currently blocked.  Pass over
+   * both the Event_Handler *and* the @a mask to allow the caller to
+   * dictate which Event_Handler method the Reactor_Impl will
    * invoke.  The ACE_Time_Value indicates how long to blocking
-   * trying to notify the <Reactor_Impl>.  If @a timeout == 0, the
+   * trying to notify the Reactor_Impl.  If @a timeout == 0, the
    * caller will block until action is possible, else will wait until
    * the relative time specified in *@a timeout elapses).
    */
@@ -66,29 +66,29 @@ public:
                       ACE_Time_Value *timeout = 0) = 0;
 
   /// Handles pending threads (if any) that are waiting to unblock the
-  /// <Reactor_Impl>.
+  /// Reactor_Impl.
   virtual int dispatch_notifications (int &number_of_active_handles,
                                       ACE_Handle_Set &rd_mask) = 0;
 
   /// Returns the ACE_HANDLE of the notify pipe on which the reactor
   /// is listening for notifications so that other threads can unblock
-  /// the <Reactor_Impl>
+  /// the Reactor_Impl
   virtual ACE_HANDLE notify_handle (void) = 0;
 
   /// Verify whether the buffer has dispatchable info  or not.
   virtual int is_dispatchable (ACE_Notification_Buffer &buffer)= 0;
 
-  /// Handle one of the notify call on the <handle>. This could be
-  /// because of a thread trying to unblock the <Reactor_Impl>
+  /// Handle one of the notify call on the handle. This could be
+  /// because of a thread trying to unblock the Reactor_Impl
   virtual int dispatch_notify (ACE_Notification_Buffer &buffer) = 0;
 
   /// Read one of the notify call on the @a handle into the
   /// @a buffer. This could be because of a thread trying to unblock
-  /// the <Reactor_Impl>
+  /// the Reactor_Impl
   virtual int read_notify_pipe (ACE_HANDLE handle,
                                 ACE_Notification_Buffer &buffer) = 0;
   /**
-   * Set the maximum number of times that the <handle_input> method
+   * Set the maximum number of times that the @c handle_input method
    * 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
@@ -99,7 +99,7 @@ public:
   virtual void max_notify_iterations (int) = 0;
 
   /**
-   * Get the maximum number of times that the <handle_input> method
+   * Get the maximum number of times that the @c handle_input method
    * will iterate and dispatch the ACE_Event_Handlers that are
    * passed in via the notify queue before breaking out of its event
    * loop.
@@ -181,8 +181,8 @@ public:
    * dispatched, 0 if the @a max_wait_time elapsed without dispatching
    * any handlers, or -1 if an error occurs.
    *
-   * The only difference between <alertable_handle_events> and
-   * <handle_events> is that in the alertable case, the eventloop will
+   * The only difference between alertable_handle_events() and
+   * handle_events() is that in the alertable case, the eventloop will
    * return when the system queues an I/O completion routine or an
    * Asynchronous Procedure Call.
    */
@@ -194,8 +194,8 @@ public:
    * @a max_wait_time value is a reference and can therefore never be
    * NULL.
    *
-   * The only difference between <alertable_handle_events> and
-   * <handle_events> is that in the alertable case, the eventloop will
+   * The only difference between alertable_handle_events() and
+   * handle_events() is that in the alertable case, the eventloop will
    * return when the system queues an I/O completion routine or an
    * Asynchronous Procedure Call.
    */
@@ -206,8 +206,8 @@ public:
 
   /**
    * Return the status of Reactor.  If this function returns 0, the reactor is
-   * actively handling events.  If it returns non-zero, <handling_events> and
-   * <handle_alertable_events> return -1 immediately.
+   * actively handling events.  If it returns non-zero, handling_events() and
+   * handle_alertable_events() return -1 immediately.
    */
   virtual int deactivated (void) = 0;
 
@@ -221,12 +221,12 @@ public:
   // = Register and remove Handlers.
 
   /// Register @a event_handler with @a mask.  The I/O handle will always
-  /// come from <get_handle> on the @a event_handler.
+  /// come from get_handle() on the @a event_handler.
   virtual int register_handler (ACE_Event_Handler *event_handler,
                                 ACE_Reactor_Mask mask) = 0;
 
   /// Register @a event_handler with @a mask.  The I/O handle is provided
-  /// through the <io_handle> parameter.
+  /// through the @a io_handle parameter.
   virtual int register_handler (ACE_HANDLE io_handle,
                                 ACE_Event_Handler *event_handler,
                                 ACE_Reactor_Mask mask) = 0;
@@ -242,8 +242,8 @@ public:
 
   /**
    * Register an @a event_handler that will be notified when
-   * <event_handle> is signaled.  Since no event mask is passed
-   * through this interface, it is assumed that the <event_handle>
+   * event_handle is signaled.  Since no event mask is passed
+   * through this interface, it is assumed that the @a event_handler
    * being passed in is an event handle and not an I/O handle.
    */
   virtual int register_handler (ACE_Event_Handler *event_handler,
@@ -253,7 +253,7 @@ public:
 
   /**
    * Register an @a event_handler that will be notified when
-   * <event_handle> is signaled.  @a mask specifies the network events
+   * event_handle is signaled.  @a mask specifies the network events
    * that the @a event_handler is interested in.
    */
   virtual int register_handler (ACE_HANDLE event_handle,
@@ -261,7 +261,7 @@ public:
                                 ACE_Event_Handler *event_handler,
                                 ACE_Reactor_Mask mask) = 0;
 
-  /// Register @a event_handler with all the @a 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;
@@ -285,8 +285,8 @@ public:
 
   /**
    * Removes @a event_handler.  Note that the I/O handle will be
-   * obtained using <get_handle> method of @a event_handler .  If
-   * @a mask == ACE_Event_Handler::DONT_CALL then the <handle_close>
+   * obtained using get_handle() method of @a event_handler .  If
+   * @a mask == ACE_Event_Handler::DONT_CALL then the handle_close()
    * method of the @a event_handler is not invoked.
    */
   virtual int remove_handler (ACE_Event_Handler *event_handler,
@@ -294,7 +294,7 @@ public:
 
   /**
    * Removes @a handle.  If @a mask == ACE_Event_Handler::DONT_CALL
-   * then the <handle_close> method of the associated <event_handler>
+   * then the handle_close() method of the associated event_handler
    * is not invoked.
    */
   virtual int remove_handler (ACE_HANDLE handle,
@@ -302,8 +302,8 @@ public:
 
   /**
    * 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.
+   * ACE_Event_Handler::DONT_CALL then the handle_close() method of
+   * the associated event_handlers is not invoked.
    */
   virtual int remove_handler (const ACE_Handle_Set &handle_set,
                               ACE_Reactor_Mask mask) = 0;
@@ -319,13 +319,13 @@ public:
                               ACE_Sig_Action *old_disp = 0,
                               int sigkey = -1) = 0;
 
-  /// Calls <remove_handler> for every signal in @a sigset.
+  /// Calls remove_handler() for every signal in @a sigset.
   virtual int remove_handler (const ACE_Sig_Set &sigset) = 0;
 
   // = Suspend and resume Handlers.
 
-  /// Suspend @a event_handler temporarily.  Use
-  /// <ACE_Event_Handler::get_handle> to get the handle.
+  /// Suspend @a event_handler temporarily.  Uses
+  /// ACE_Event_Handler::get_handle() to get the handle.
   virtual int suspend_handler (ACE_Event_Handler *event_handler) = 0;
 
   /// Suspend @a handle temporarily.
@@ -337,7 +337,7 @@ public:
   /// Suspend all <handles> temporarily.
   virtual int suspend_handlers (void) = 0;
 
-  /// Resume @a event_handler. Use <ACE_Event_Handler::get_handle> to
+  /// Resume @a event_handler. Uses ACE_Event_Handler::get_handle() to
   /// get the handle.
   virtual int resume_handler (ACE_Event_Handler *event_handler) = 0;
 
@@ -347,7 +347,7 @@ public:
   /// Resume all @a handles in handle set.
   virtual int resume_handler (const ACE_Handle_Set &handles) = 0;
 
-  /// Resume all <handles>.
+  /// Resume all handles.
   virtual int resume_handlers (void) = 0;
 
   /// Does the reactor allow the application to resume the handle on
@@ -388,7 +388,7 @@ public:
   /**
    * Resets the interval of the timer represented by @a timer_id to
    * @a interval, which is specified in relative time to the current
-   * <gettimeofday>.  If @a interval is equal to
+   * gettimeofday().  If @a interval is equal to
    * ACE_Time_Value::zero, the timer will become a non-rescheduling
    * timer.  Returns 0 if successful, -1 if not.
    */