Merge pull request #1049 from jwillemsen/master

Documentation changes

6 files changed, 41 insertions, 57 deletions

diff --git a/ACE/ace/Dev_Poll_Reactor.h b/ACE/ace/Dev_Poll_Reactor.h
index 4720a118835..d3188a55751 100644
--- a/ACE/ace/Dev_Poll_Reactor.h
+++ b/ACE/ace/Dev_Poll_Reactor.h
@@ -51,7 +51,6 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
 class ACE_Sig_Handler;
 class ACE_Dev_Poll_Reactor;
 
-
 // ---------------------------------------------------------------------
 
 /**
@@ -98,7 +97,7 @@ public:
   /// Unimplemented method required by pure virtual method in abstract
   /// base class.
   /**
-   * This method's interface is not very compatibile with this
+   * This method's interface is not very compatible with this
    * Reactor's design.  It's not clear why this method is pure virtual
    * either.
    */
diff --git a/ACE/ace/MMAP_Memory_Pool.h b/ACE/ace/MMAP_Memory_Pool.h
index 15af35692c0..70455ba79ec 100644
--- a/ACE/ace/MMAP_Memory_Pool.h
+++ b/ACE/ace/MMAP_Memory_Pool.h
@@ -245,9 +245,9 @@ protected:
    * SIGSEGV) will be triggered.  At that point, the ACE_Sig_Handler
    * (which is part of the ACE_Reactor) will catch the signal and
    * dispatch the handle_signal() method defined here.  If the SIGSEGV
-   * signal occurred due to the fact that the mapping wasn't uptodate
+   * signal occurred due to the fact that the mapping wasn't up to date
    * with respect to the backing store, the handler method below will
-   * update the mapping accordingly.  When the signal handler returns,
+   * update the mapping accordingly. When the signal handler returns,
    * the instruction should be restarted and the operation should work.
    */
   virtual int handle_signal (int signum, siginfo_t *, ucontext_t *);
diff --git a/ACE/ace/Msg_WFMO_Reactor.h b/ACE/ace/Msg_WFMO_Reactor.h
index 1440965f55e..6adb3d5d433 100644
--- a/ACE/ace/Msg_WFMO_Reactor.h
+++ b/ACE/ace/Msg_WFMO_Reactor.h
@@ -33,19 +33,19 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  * Win32 <MsgWaitForMultipleObjects>.
  *
  * The ACE_Msg_WFMO_Reactor is an OO event demultiplexor and
- * event handler Reactor. It differs from <ACE_WFMO_Reactor> by
+ * event handler Reactor. It differs from ACE_WFMO_Reactor by
  * its ability to react on Windows messages.  It is needed when
  * the task should serve also as a COM/DCOM server.
  */
 class ACE_Export ACE_Msg_WFMO_Reactor : public ACE_WFMO_Reactor
 {
 public:
-  /// Initialize <ACE_Msg_WFMO_Reactor> with the default size.
+  /// Initialize ACE_Msg_WFMO_Reactor with the default size.
   ACE_Msg_WFMO_Reactor (ACE_Sig_Handler * = 0,
                         ACE_Timer_Queue * = 0);
 
   /**
-   * Initialize <ACE_Msg_WFMO_Reactor> with size @a size.  Two slots will be
+   * Initialize ACE_Msg_WFMO_Reactor with size @a size.  Two slots will be
    * added to the @a size parameter which will store handles used for
    * internal management purposes.
    */
diff --git a/ACE/ace/QtReactor/QtReactor.cpp b/ACE/ace/QtReactor/QtReactor.cpp
index ac9fab0c903..99066b8c599 100644
--- a/ACE/ace/QtReactor/QtReactor.cpp
+++ b/ACE/ace/QtReactor/QtReactor.cpp
@@ -5,7 +5,6 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
 ACE_ALLOC_HOOK_DEFINE (ACE_QtReactor)
 
 // Must be called with lock held
-
 ACE_QtReactor::ACE_QtReactor (QApplication *qapp ,
     ACE_Sig_Handler *sh,
     ACE_Timer_Queue *tq,
diff --git a/ACE/ace/Sig_Handler.cpp b/ACE/ace/Sig_Handler.cpp
index 577a1e43035..e91de0b4fb4 100644
--- a/ACE/ace/Sig_Handler.cpp
+++ b/ACE/ace/Sig_Handler.cpp
@@ -36,16 +36,14 @@ ace_sig_handlers_dispatch (int signum, siginfo_t *info, ucontext_t *context)
 #define ace_signal_handlers_dispatcher ACE_SignalHandler(ACE_Sig_Handlers::dispatch)
 #endif /* ACE_HAS_SIG_C_FUNC */
 
-
 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
 
-// Array of Event_Handlers that will handle the signals.
+/// Array of Event_Handlers that will handle the signals.
 ACE_Event_Handler *ACE_Sig_Handler::signal_handlers_[ACE_NSIG];
 
-// Remembers if a signal has occurred.
+/// Remembers if a signal has occurred.
 sig_atomic_t ACE_Sig_Handler::sig_pending_ = 0;
 
-
 ACE_ALLOC_HOOK_DEFINE(ACE_Sig_Handler)
 
 ACE_Sig_Handler::~ACE_Sig_Handler (void)
@@ -131,10 +129,9 @@ ACE_Sig_Handler::handler (int signum,
   return ACE_Sig_Handler::handler_i (signum, new_sh);
 }
 
-// Register an ACE_Event_Handler along with the corresponding SIGNUM.
-// This method does NOT acquire any locks, so it can be called from a
-// signal handler.
-
+/// Register an ACE_Event_Handler along with the corresponding SIGNUM.
+/// This method does NOT acquire any locks, so it can be called from a
+/// signal handler.
 int
 ACE_Sig_Handler::register_handler_i (int signum,
                                      ACE_Event_Handler *new_sh,
@@ -169,10 +166,9 @@ ACE_Sig_Handler::register_handler_i (int signum,
     return -1;
 }
 
-// Register an ACE_Event_Handler along with the corresponding SIGNUM.
-// This method acquires a lock, so it can't be called from a signal
-// handler, e.g., <dispatch>.
-
+/// Register an ACE_Event_Handler along with the corresponding SIGNUM.
+/// This method acquires a lock, so it can't be called from a signal
+/// handler, e.g., <dispatch>.
 int
 ACE_Sig_Handler::register_handler (int signum,
                                    ACE_Event_Handler *new_sh,
@@ -220,8 +216,7 @@ ACE_Sig_Handler::remove_handler_i (int signum,
   return new_disp->register_action (signum, old_disp);
 }
 
-// Remove an ACE_Event_Handler.
-
+/// Remove an ACE_Event_Handler.
 int
 ACE_Sig_Handler::remove_handler (int signum,
                                  ACE_Sig_Action *new_disp,
@@ -240,9 +235,8 @@ ACE_Sig_Handler::remove_handler (int signum,
   return -1;
 }
 
-// Master dispatcher function that gets called by a signal handler and
-// dispatches one handler...
-
+/// Master dispatcher function that gets called by a signal handler and
+/// dispatches one handler...
 void
 ACE_Sig_Handler::dispatch (int signum,
                            siginfo_t *siginfo,
@@ -285,13 +279,13 @@ ACE_Sig_Handler::dispatch (int signum,
 // from compiling...
 #define ACE_MAX_SIGNAL_HANDLERS ((size_t) 20)
 
-// Keeps track of the id that uniquely identifies each registered
-// signal handler.  This id can be used to cancel a timer via the
-// <remove_handler> method.
+/// Keeps track of the id that uniquely identifies each registered
+/// signal handler.  This id can be used to cancel a timer via the
+/// <remove_handler> method.
 int ACE_Sig_Handlers::sigkey_ = 0;
 
-// If this is true then a 3rd party library has registered a
-// handler...
+/// If this is true then a 3rd party library has registered a
+/// handler...
 bool ACE_Sig_Handlers::third_party_sig_handler_ = false;
 
 // Make life easier by defining typedefs...
@@ -337,9 +331,8 @@ ACE_Sig_Handlers::dump (void) const
 #endif /* ACE_HAS_DUMP */
 }
 
-// This is the method that does all the dirty work...  The basic
-// structure of this method was devised by Detlef Becker.
-
+/// This is the method that does all the dirty work...  The basic
+/// structure of this method was devised by Detlef Becker.
 int
 ACE_Sig_Handlers::register_handler (int signum,
                                     ACE_Event_Handler *new_sh,
@@ -402,10 +395,10 @@ ACE_Sig_Handlers::register_handler (int signum,
                       ACE_Sig_Adapter (new_sh,
                                        ++ACE_Sig_Handlers::sigkey_),
                       -1);
+
       // Add the ACE signal handler to the set of handlers for this
       // signal (make sure it goes before the external one if there is
       // one of these).
-
       int result = ACE_Sig_Handlers_Set::instance (signum)->insert (ace_sig_adapter);
 
       if (result == -1)
@@ -465,11 +458,10 @@ ACE_Sig_Handlers::register_handler (int signum,
   return -1;
 }
 
-// Remove the ACE_Event_Handler currently associated with <signum>.
-// Install the new disposition (if given) and return the previous
-// disposition (if desired by the caller).  Returns 0 on success and
-// -1 if <signum> is invalid.
-
+/// Remove the ACE_Event_Handler currently associated with @a signum.
+/// Install the new disposition (if given) and return the previous
+/// disposition (if desired by the caller).  Returns 0 on success and
+// -1 if @a signum is invalid.
 int
 ACE_Sig_Handlers::remove_handler (int signum,
                                   ACE_Sig_Action *new_disp,
@@ -490,7 +482,6 @@ ACE_Sig_Handlers::remove_handler (int signum,
       ACE_SIG_HANDLERS_ITERATOR handler_iterator (*handler_set);
 
       // Iterate through the set of handlers for this signal.
-
       for (ACE_Event_Handler **eh;
            handler_iterator.next (eh) != 0;
            )
@@ -501,7 +492,6 @@ ACE_Sig_Handlers::remove_handler (int signum,
           // Remove the handler if (1) its key matches the key we've
           // been told to remove or (2) if we've been told to remove
           // *all* handlers (i.e., <sigkey> == -1).
-
           if (sh->sigkey () == sigkey || sigkey == -1)
             {
               handler_set->remove (*eh);
@@ -514,7 +504,6 @@ ACE_Sig_Handlers::remove_handler (int signum,
           // If there are no more handlers left for a signal then
           // register the new disposition or restore the default
           // disposition.
-
           ACE_Sig_Action sa (SIG_DFL, (sigset_t *) 0);
 
           if (new_disp == 0)
@@ -528,9 +517,8 @@ ACE_Sig_Handlers::remove_handler (int signum,
     return -1;
 }
 
-// Master dispatcher function that gets called by a signal handler and
-// dispatches *all* the handlers...
-
+/// Master dispatcher function that gets called by a signal handler and
+/// dispatches *all* the handlers...
 void
 ACE_Sig_Handlers::dispatch (int signum,
                             siginfo_t *siginfo,
@@ -569,10 +557,9 @@ ACE_Sig_Handlers::dispatch (int signum,
       }
 }
 
-// Return the first item in the list of handlers.  Note that this will
-// trivially provide the same behavior as the ACE_Sig_Handler
-// version if there is only 1 handler registered!
-
+/// Return the first item in the list of handlers.  Note that this will
+/// trivially provide the same behavior as the ACE_Sig_Handler
+/// version if there is only 1 handler registered!
 ACE_Event_Handler *
 ACE_Sig_Handlers::handler (int signum)
 {
@@ -585,12 +572,11 @@ ACE_Sig_Handlers::handler (int signum)
   return *eh;
 }
 
-// The following is a strange bit of logic that tries to give the same
-// semantics as what happens in ACE_Sig_Handler when we replace the
-// current signal handler with a new one.  Note that if there is only
-// one signal handler the behavior will be identical.  If there is
-// more than one handler then things get weird...
-
+/// The following is a strange bit of logic that tries to give the same
+/// semantics as what happens in ACE_Sig_Handler when we replace the
+/// current signal handler with a new one.  Note that if there is only
+/// one signal handler the behavior will be identical.  If there is
+/// more than one handler then things get weird...
 ACE_Event_Handler *
 ACE_Sig_Handlers::handler (int signum, ACE_Event_Handler *new_sh)
 {
diff --git a/ACE/ace/Sig_Handler.h b/ACE/ace/Sig_Handler.h
index e71b153fb38..1bd2a66d464 100644
--- a/ACE/ace/Sig_Handler.h
+++ b/ACE/ace/Sig_Handler.h
@@ -195,7 +195,7 @@ public:
 
   // = Set/get the handler associated with a particular signal.
 
-  /// Return the head of the list of <ACE_Sig_Handler>s associated with
+  /// Return the head of the list of ACE_Sig_Handlers associated with
   /// SIGNUM.
   virtual ACE_Event_Handler *handler (int signum);
 
@@ -209,7 +209,7 @@ public:
 
   /**
    * Callback routine registered with sigaction(2) that dispatches the
-   * <handle_signal> method of all the pre-registered
+   * handle_signal() method of all the pre-registered
    * ACE_Event_Handlers for @a signum
    */
   static void dispatch (int signum, siginfo_t *, ucontext_t *);