ChangeLogTag: Mon Sep 16 05:35:12 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl>

9 files changed, 104 insertions, 70 deletions

diff --git a/ChangeLog b/ChangeLog
index e988973ad94..f0c61bfc3aa 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,19 @@
+Mon Sep 16 07:35:12 UTC 2002  Johnny Willemsen  <jwillemsen@remedy.nl>
+
+        * ace/config-doxygen.h:
+          Added define ACE_HAS_EVENT_POLL to generate Dev_Poll reactor
+          documentation
+
+        * ace/Acceptor.h:
+        * ace/Containers_T.{h,cpp}:
+        * ace/Dev_Poll_Reactor.h:
+        * ace/Sample_History.h:
+        * ace/Service_Config.h:
+          Improved doxygen documentation.
+
 Sat Sep 14 10:34:34 2002  Douglas C. Schmidt  <schmidt@ace.cs.wustl.edu>
 
-	* ace/config-freebsd-pthread.h: Added 
+	* ace/config-freebsd-pthread.h: Added
 	  #undef ACE_LACKS_UCONTEXT_H if we're compiling for FreeBSD
  	  version > 4.  Thanks to Christophe Juniet
  	  <cjuniet@entreview.com> for reporting this.
@@ -23,7 +36,7 @@ Fri Sep 13 08:37:09 2002  Ossama Othman  <ossama@uci.edu>
 
 	  Files to silence annoying CVS messages regarding generated files
 	  it doesn't know about.
-	  
+
 Fri Sep 13 08:57:03 2002  Chad Elliott  <elliott_c@ociweb.com>
 
         * bin/MakeProjectCreator/USAGE:
diff --git a/ChangeLogs/ChangeLog-03a b/ChangeLogs/ChangeLog-03a
index e988973ad94..f0c61bfc3aa 100644
--- a/ChangeLogs/ChangeLog-03a
+++ b/ChangeLogs/ChangeLog-03a
@@ -1,6 +1,19 @@
+Mon Sep 16 07:35:12 UTC 2002  Johnny Willemsen  <jwillemsen@remedy.nl>
+
+        * ace/config-doxygen.h:
+          Added define ACE_HAS_EVENT_POLL to generate Dev_Poll reactor
+          documentation
+
+        * ace/Acceptor.h:
+        * ace/Containers_T.{h,cpp}:
+        * ace/Dev_Poll_Reactor.h:
+        * ace/Sample_History.h:
+        * ace/Service_Config.h:
+          Improved doxygen documentation.
+
 Sat Sep 14 10:34:34 2002  Douglas C. Schmidt  <schmidt@ace.cs.wustl.edu>
 
-	* ace/config-freebsd-pthread.h: Added 
+	* ace/config-freebsd-pthread.h: Added
 	  #undef ACE_LACKS_UCONTEXT_H if we're compiling for FreeBSD
  	  version > 4.  Thanks to Christophe Juniet
  	  <cjuniet@entreview.com> for reporting this.
@@ -23,7 +36,7 @@ Fri Sep 13 08:37:09 2002  Ossama Othman  <ossama@uci.edu>
 
 	  Files to silence annoying CVS messages regarding generated files
 	  it doesn't know about.
-	  
+
 Fri Sep 13 08:57:03 2002  Chad Elliott  <elliott_c@ociweb.com>
 
         * bin/MakeProjectCreator/USAGE:
diff --git a/ace/Acceptor.h b/ace/Acceptor.h
index 605b5d5dc65..8bf2598a73f 100644
--- a/ace/Acceptor.h
+++ b/ace/Acceptor.h
@@ -282,25 +282,25 @@ public:
    * interval, the client can shutdown the connection, in which case,
    * the <accept> call can hang.
    *
-   * @arg local_addr   The address to listen at.
-   * @arg reactor      Pointer to the ACE_Reactor instance to register
-   *                   this object with. The default is the singleton.
-   * @arg flags        Flags to control what mode an accepted socket
-   *                   will be put into after it is accepted. The only
-   *                   legal value for this argument is @c ACE_NONBLOCK,
-   *                   which enables non-blocking mode on the accepted
-   *                   peer stream object in @c SVC_HANDLER.  The default
-   *                   is 0.
-   * @arg use_select   Affects behavior when called back by the reactor
-   *                   when a connection can be accepted.  If non-zero,
-   *                   this object will accept all pending connections,
-   *                   intead of just the one that triggered the reactor
-   *                   callback.  Uses ACE_OS::select() internally to
-   *                   detect any remaining acceptable connections.
-   *                   The default is 1.
-   * @arg reuse_addr   Passed to the @c PEER_ACCEPTOR::open() method with
-   *                   @p local_addr.  Generally used to request that the
-   *                   OS allow reuse of the listen port.  The default is 1.
+   * @param local_addr   The address to listen at.
+   * @param reactor      Pointer to the ACE_Reactor instance to register
+   *                     this object with. The default is the singleton.
+   * @param flags        Flags to control what mode an accepted socket
+   *                     will be put into after it is accepted. The only
+   *                     legal value for this argument is @c ACE_NONBLOCK,
+   *                     which enables non-blocking mode on the accepted
+   *                     peer stream object in @c SVC_HANDLER.  The default
+   *                     is 0.
+   * @param use_select   Affects behavior when called back by the reactor
+   *                     when a connection can be accepted.  If non-zero,
+   *                     this object will accept all pending connections,
+   *                     intead of just the one that triggered the reactor
+   *                     callback.  Uses ACE_OS::select() internally to
+   *                     detect any remaining acceptable connections.
+   *                     The default is 1.
+   * @param reuse_addr   Passed to the @c PEER_ACCEPTOR::open() method with
+   *                     @p local_addr.  Generally used to request that the
+   *                     OS allow reuse of the listen port.  The default is 1.
    *
    * @retval 0  Success
    * @retval -1 Failure, @c errno contains an error code.
diff --git a/ace/Containers_T.cpp b/ace/Containers_T.cpp
index 78a0f3666b2..faa5c0b3814 100644
--- a/ace/Containers_T.cpp
+++ b/ace/Containers_T.cpp
@@ -1520,7 +1520,7 @@ ACE_Ordered_MultiSet<T>::insert (const T &item)
 
 template <class T> int
 ACE_Ordered_MultiSet<T>::insert (const T &new_item,
-                                 ACE_Ordered_MultiSet_Iterator<T> &iter)
+                                 ITERATOR &iter)
 {
   // ACE_TRACE ("ACE_Ordered_MultiSet<T>::insert using iterator");
 
@@ -1563,7 +1563,7 @@ ACE_Ordered_MultiSet<T>::remove (const T &item)
 
 template <class T> int
 ACE_Ordered_MultiSet<T>::find (const T &item,
-                               ACE_Ordered_MultiSet_Iterator<T> &iter) const
+                               ITERATOR &iter) const
 {
   // search an occurance of item, using iterator's current position as a hint
   ACE_DNode<T> *node = iter.current_;
diff --git a/ace/Containers_T.h b/ace/Containers_T.h
index 18e971d5527..1cd1e016d92 100644
--- a/ace/Containers_T.h
+++ b/ace/Containers_T.h
@@ -94,9 +94,9 @@ public:
 
   /// Assignment operator
   /**
-   * Perform a deep copy operation using the Bounded_Stack parameter.  If the capacity
-   * of the lhs isn't sufficient for the rhs, then the underlying data structure will
-   * be reallocated to accomadate the larger number of elements.
+   * Perform a deep copy operation using the Bounded_Stack parameter.  If the
+   * capacity of the lhs isn't sufficient for the rhs, then the underlying data
+   * structure will be reallocated to accomadate the larger number of elements.
    */
   void operator= (const ACE_Bounded_Stack<T> &s);
 
@@ -457,14 +457,14 @@ public:
    */
   int insert (const T &new_item);
 
-  /// Remove <item> from the Stack.  Returns 0 if it removes the item,
+  /// Remove @a item from the Stack.  Returns 0 if it removes the item,
   /// -1 if it can't find the item, and -1 if a failure occurs.
   /**
    * Linear remove operation.
    */
   int remove (const T &item);
 
-  /// Finds if <item> occurs the set.  Returns 0 if finds, else -1.
+  /// Finds if @a item occurs the set.  Returns 0 if finds, else -1.
   /**
    * Linear find operation.
    */
@@ -514,7 +514,7 @@ public:
 
   // = Iteration methods.
 
-  /// Pass back the <next_item> that hasn't been seen in the Stack.
+  /// Pass back the @a next_item that hasn't been seen in the Stack.
   /// Returns 0 when all items have been seen, else 1.
   int next (T *&next_item);
 
@@ -963,16 +963,17 @@ protected:
 
   ///Constant time insert a new item into the list structure.
   /**
-   * Insert a <new_element> into the list.  It will be added before
-   * or after <old_item>.  Default is to insert the new item *after*
+   * Insert a @a new_item into the list.  It will be added before
+   * or after @a old_item.  Default is to insert the new item *after*
    * <head_>.  Return 0 if succeed, -1 if error occured.
    */
   int insert_element (T *new_item,
                       int before = 0,
                       T *old_item = 0);
+
   ///Constant time delete an item from the list structure.
   /**
-   * Remove an <item> from the list.  Return 0 if succeed, -1 otherwise.
+   * Remove @a item from the list.  Return 0 if succeed, -1 otherwise.
    * Notice that this function checks if item is <head_> and either its
    * <next_> or <prev_> is NULL.  The function resets item's <next_> and
    * <prev_> to 0 to prevent clobbering the double-linked list if a user
@@ -1121,10 +1122,12 @@ public:
    */
   T *next (void) const;
 
-  /// Removes the current item (i.e., <next>) from the list.
-  /// Note that DLList iterators do not support <advance_and_remove>
-  /// directly (defined in its base class) and you will need to
-  /// release the element returned by it.
+  /**
+   * Removes the current item (i.e., <next>) from the list.
+   * Note that DLList iterators do not support <advance_and_remove>
+   * directly (defined in its base class) and you will need to
+   * release the element returned by it.
+   */
   int remove (void);
 
   /// Delegates to ACE_Double_Linked_List_Iterator.
@@ -1374,7 +1377,7 @@ public:
 
   ///Linear time insertion of an item unique to the set.
   /**
-   * Insert <new_item> into the set (doesn't allow duplicates).
+   * Insert @a new_item into the set (doesn't allow duplicates).
    * Returns -1 if failures occur, 1 if item is already present, else
    * 0.
    */
@@ -1384,13 +1387,13 @@ public:
   /**
    * Remove first occurrence of <item> from the set.  Returns 0 if
    * it removes the item, -1 if it can't find the item, and -1 if a
-   * failure occurs.  Removal doesn't reclaim memory for the <item>.
+   * failure occurs.  Removal doesn't reclaim memory for the @a item.
    */
   int remove (const T &item);
 
-  /// Finds if <item> occurs in the set.  Returns 0 if finds, else -1.
+  /// Finds if @a item occurs in the set.  Returns 0 if finds, else -1.
   /**
-   * Performs a linear find operation for the specified <item>.
+   * Performs a linear find operation for the specified @a item.
    */
   int find (const T &item) const;
 
@@ -1536,8 +1539,8 @@ public:
 
   /// Construct a Bounded_Set with the provided sizeB.
   /**
-   * Initialize the Bounded_Set to have a maximum size equal to the size parameter
-   * specified.
+   * Initialize the Bounded_Set to have a maximum size equal to the size
+   * parameter specified.
    */
   ACE_Bounded_Set (size_t size);
 
@@ -1566,13 +1569,15 @@ public:
 
   /// Returns 1 if the container is empty, otherwise returns 0.
   /**
-   * A constant time check is performed to determine if the Bounded_Set is empty.
+   * A constant time check is performed to determine if the Bounded_Set is
+   * empty.
    */
   int is_empty (void) const;
 
   /// Returns 1 if the container is full, otherwise returns 0.
   /**
-   * Performs a constant time check to determine if the Bounded_Set is at capacity.
+   * Performs a constant time check to determine if the Bounded_Set is at
+   * capacity.
    */
   int is_full (void) const;
 
@@ -1580,7 +1585,7 @@ public:
 
   ///Inserts a new element unique to the set.
   /**
-   * Insert <new_item> into the set (doesn't allow duplicates) in linear
+   * Insert @a new_item into the set (doesn't allow duplicates) in linear
    * time.
    * Returns -1 if failures occur, 1 if item is already present, else
    * 0.
@@ -1589,14 +1594,14 @@ public:
 
   ///Finds the specified element and removes it from the set.
   /**
-   * Remove first occurrence of <item> from the set.  Returns 0 if it
+   * Remove first occurrence of @a item from the set.  Returns 0 if it
    * removes the item, -1 if it can't find the item, and -1 if a
    * failure occurs.  The linear remove operation does not reclaim the
    * memory associated with the removed item.
    */
   int remove (const T &item);
 
-  /// Finds if <item> occurs in the set.  Returns 0 if finds, else -1.
+  /// Finds if @a item occurs in the set.  Returns 0 if finds, else -1.
   /**
    * find preforms a linear search for <item> and returns 0 on successful
    * find and -1 otherwise.
@@ -1784,7 +1789,7 @@ public:
 
   // = Classic unordered set operations.
 
-  /// Insert <new_item> into the ordered multiset.
+  /// Insert @a new_item into the ordered multiset.
   /// Returns -1 if failures occur, else 0.
   /**
    * Linear time, order preserving insert into the set beginning at the head.
@@ -1793,14 +1798,14 @@ public:
 
   ///Linear time insert beginning at the point specified by the provided iterator.
   /**
-   * Insert <new_item> into the ordered multiset, starting its search at
+   * Insert @a new_item into the ordered multiset, starting its search at
    * the node pointed to by the iterator, and if insertion was successful,
    * updates the iterator to point to the newly inserted node.
    * Returns -1 if failures occur, else 0.
    */
   int insert (const T &new_item, ITERATOR &iter);
 
-  /// Remove first occurrence of <item> from the set.  Returns 0 if
+  /// Remove first occurrence of @a item from the set.  Returns 0 if
   /// it removes the item, -1 if it can't find the item.
   /**
    * Linear time search operation which removes the item from the set if found .
@@ -1809,14 +1814,14 @@ public:
 
   ///Linear find operation.
   /**
-   * Finds first occurrence of <item> in the multiset, using the iterator's
+   * Finds first occurrence of @a item in the multiset, using the iterator's
    * current position as a hint to improve performance. If find succeeds,
    * it positions the iterator at that node and returns 0, or if it cannot
    * locate the node, it leaves the iterator alone and just returns -1.
    */
   int find (const T &item, ITERATOR &iter) const;
 
-  /// Reset the <ACE_Ordered_MultiSet> to be empty.
+  /// Reset the ACE_Ordered_MultiSet to be empty.
   /**
    * Delete the nodes inside the set.
    */
@@ -1831,7 +1836,7 @@ public:
 private:
 
   /**
-   * Insert <item>, starting its search at the position given,
+   * Insert @a item, starting its search at the position given,
    * and if successful updates the passed pointer to point to
    * the newly inserted item's node.
    */
@@ -1839,7 +1844,7 @@ private:
                    ACE_DNode<T> **new_position);
 
   /**
-   * looks for first occurance of <item> in the ordered set, using the
+   * Looks for first occurance of @a item in the ordered set, using the
    * passed starting position as a hint: if there is such an instance, it
    * updates the new_position pointer to point to this node and returns 0;
    * if there is no such node, then if there is a node before where the
diff --git a/ace/Dev_Poll_Reactor.h b/ace/Dev_Poll_Reactor.h
index 3a559554df2..5461f3d66fb 100644
--- a/ace/Dev_Poll_Reactor.h
+++ b/ace/Dev_Poll_Reactor.h
@@ -741,7 +741,7 @@ public:
    *
    * @param event_handler  event handler to schedule on reactor
    * @param arg   argument passed to the handle_timeout() method of  event_handler
-   * @param delta  time interval after which the timer will expire
+   * @param delay  time interval after which the timer will expire
    * @param interval  time interval after which the timer will be automatically rescheduled
    * @return -1 on failure, a timer_id value on success
    */
diff --git a/ace/Sample_History.h b/ace/Sample_History.h
index 8d5dc913b52..d2b0d03d929 100644
--- a/ace/Sample_History.h
+++ b/ace/Sample_History.h
@@ -55,7 +55,7 @@ public:
 
   /// Dump all the samples
   /**
-   * Prints out all the samples, using @param msg as a prefix for each
+   * Prints out all the samples, using @a msg as a prefix for each
    * message.
    */
   void dump_samples (const ACE_TCHAR *msg,
diff --git a/ace/Service_Config.h b/ace/Service_Config.h
index 32b239b7bf3..98cc4eced9e 100644
--- a/ace/Service_Config.h
+++ b/ace/Service_Config.h
@@ -129,7 +129,7 @@ public:
 
   /**
    * Performs an open without parsing command-line arguments.  The
-   * <logger_key> indicates where to write the logging output, which
+   * @a logger_key indicates where to write the logging output, which
    * is typically either a STREAM pipe or a socket address.
    */
   ACE_Service_Config (const ACE_TCHAR program_name[],
@@ -173,7 +173,7 @@ public:
   /**
    * This is the primary entry point into the ACE_Service_Config (the
    * constructor just handles simple initializations).  It parses
-   * arguments passed in from @c argc and @c argv parameters.  The
+   * arguments passed in from @a argc and @a argv parameters.  The
    * arguments that are valid in a call to this method include:
    *
    * - '-b' Option to indicate that we should be a daemon. Note that when
@@ -197,16 +197,16 @@ public:
    *        Please observe the difference between options '-f' that looks
    *        for a list of files and here a list of services.
    *
-   * @arg logger_key   indicates where to write the logging output,
-   *                   which is typically either a STREAM pipe or a
-   *                   socket address.
-   * @arg ignore_static_svcs   if 1 then static services are not loaded,
-   *                   otherwise, they are loaded.
-   * @arg ignore_default_svc_conf_file  if non-0 then the @c svc.conf
-   *                   configuration file will be ignored.
-   * @arg ignore_debug_flag> if non-0 then the application is responsible
-   *                   for setting the @c ACE_Log_Msg::priority_mask
-   *                   appropriately.
+   * @param logger_key   Indicates where to write the logging output,
+   *                     which is typically either a STREAM pipe or a
+   *                     socket address.
+   * @param ignore_static_svcs   If 1 then static services are not loaded,
+   *                             otherwise, they are loaded.
+   * @param ignore_default_svc_conf_file  If non-0 then the @c svc.conf
+   *                                      configuration file will be ignored.
+   * @param ignore_debug_flag If non-0 then the application is responsible
+   *                          for setting the @c ACE_Log_Msg::priority_mask
+   *                          appropriately.
    *
    * @retval -1   the configuration file is not found or cannot
    *              be opened (errno is set accordingly).
diff --git a/ace/config-doxygen.h b/ace/config-doxygen.h
index b79df2325d6..6161307f2dc 100644
--- a/ace/config-doxygen.h
+++ b/ace/config-doxygen.h
@@ -91,4 +91,7 @@
 /// Generate ACE XTI ATM class documentation
 #define ACE_HAS_XTI_ATM
 
+/// Generate ACE_Dev_Poll_Reactor documentation
+#define ACE_HAS_EVENT_POLL
+
 #endif /* ACE_CONFIG_DOXYGEN_H */