ChangeLogTag: Sat Apr 13 14:32:12 2002 Johnny Willemsen <jwillemsen@remedy.nl>

11 files changed, 79 insertions, 36 deletions

diff --git a/ChangeLog b/ChangeLog
index 2e769fbc7ce..6456cf989fa 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,17 @@
+Sat Apr 13 14:33:12 2002  Johnny Willemsen  <jwillemsen@remedy.nl>
+
+        * ace/Configuration.h:
+        * ace/Containers_T.h:
+        * ace/High_Res_Timer.h:
+        * ace/Object_Manager.h:
+        * ace/Reactor.h:
+        * ace/Reactor_Impl.h:
+        * ace/Select_Reactor_T.h:
+        * ace/WFMO_Reactor.h:
+          Improved doxygen comments. Added @deprecated to methods that
+          are deprecated so that in the doxygen description this is also
+          clearly list.
+
 Sat Apr 13 03:32:52 2002  Krishnakumar B  <kitty@cs.wustl.edu>
 
         * ace/Proactor.h:
diff --git a/ChangeLogs/ChangeLog-02a b/ChangeLogs/ChangeLog-02a
index 2e769fbc7ce..6456cf989fa 100644
--- a/ChangeLogs/ChangeLog-02a
+++ b/ChangeLogs/ChangeLog-02a
@@ -1,3 +1,17 @@
+Sat Apr 13 14:33:12 2002  Johnny Willemsen  <jwillemsen@remedy.nl>
+
+        * ace/Configuration.h:
+        * ace/Containers_T.h:
+        * ace/High_Res_Timer.h:
+        * ace/Object_Manager.h:
+        * ace/Reactor.h:
+        * ace/Reactor_Impl.h:
+        * ace/Select_Reactor_T.h:
+        * ace/WFMO_Reactor.h:
+          Improved doxygen comments. Added @deprecated to methods that
+          are deprecated so that in the doxygen description this is also
+          clearly list.
+
 Sat Apr 13 03:32:52 2002  Krishnakumar B  <kitty@cs.wustl.edu>
 
         * ace/Proactor.h:
diff --git a/ChangeLogs/ChangeLog-03a b/ChangeLogs/ChangeLog-03a
index 2e769fbc7ce..6456cf989fa 100644
--- a/ChangeLogs/ChangeLog-03a
+++ b/ChangeLogs/ChangeLog-03a
@@ -1,3 +1,17 @@
+Sat Apr 13 14:33:12 2002  Johnny Willemsen  <jwillemsen@remedy.nl>
+
+        * ace/Configuration.h:
+        * ace/Containers_T.h:
+        * ace/High_Res_Timer.h:
+        * ace/Object_Manager.h:
+        * ace/Reactor.h:
+        * ace/Reactor_Impl.h:
+        * ace/Select_Reactor_T.h:
+        * ace/WFMO_Reactor.h:
+          Improved doxygen comments. Added @deprecated to methods that
+          are deprecated so that in the doxygen description this is also
+          clearly list.
+
 Sat Apr 13 03:32:52 2002  Krishnakumar B  <kitty@cs.wustl.edu>
 
         * ace/Proactor.h:
diff --git a/ace/Configuration.h b/ace/Configuration.h
index a4e30d1b43c..6ec9cec606e 100644
--- a/ace/Configuration.h
+++ b/ace/Configuration.h
@@ -9,9 +9,9 @@
  *  @author Chris Hafey <chafey@stentor.com>
  *
  *  The ACE configuration API provides a portable abstraction for
- *  program configuration similar to the Microsoft Windows registry.  
- *  The API supports a tree based hierarchy of configuration sections.  Each 
- *  section contains other sections or values.  Values may contain string, 
+ *  program configuration similar to the Microsoft Windows registry.
+ *  The API supports a tree based hierarchy of configuration sections.  Each
+ *  section contains other sections or values.  Values may contain string,
  *  unsigned integer and binary data.
  *
  *  Note: these classes are not thread safe, if multiple threads use these
@@ -241,8 +241,8 @@ public:
    * Expands <path_in> to <key_out> from <key>.  If create is true,
    * the subsections are created.  Returns 0 on success, non zero on
    * error The path consists of sections separated by the backslash
-   * '\' or forward slash '/'.  
-   * Returns 0 on success, -1 if <create) is 0 and the path refers 
+   * '\' or forward slash '/'.
+   * Returns 0 on success, -1 if <create) is 0 and the path refers
    * a nonexistant section
    */
   int expand_path (const ACE_Configuration_Section_Key& key,
@@ -251,30 +251,30 @@ public:
                    int create = 1);
 
   /**
-   * Exports the configuration database to filename.  If <filename> is
-   * already present, it is overwritten. This function is deprecated and
-   * will be removed in a future version of ACE. Please use either
-   * ACE_Registry_ImpExp or ACE_Ini_ImpExp instead.
+   * @deprecated Exports the configuration database to filename.
+   * If <filename> is already present, it is overwritten. This function is
+   * deprecated and will be removed in a future version of ACE. Please use
+   * either ACE_Registry_ImpExp or ACE_Ini_ImpExp instead.
    */
   int export_config (const ACE_TCHAR* filename);
 
   /**
-   * Imports the configuration database from filename.  Any existing
-   * data is not removed. This function is deprecated and will be
+   * @deprecated Imports the configuration database from filename.  Any
+   * existing data is not removed. This function is deprecated and will be
    * removed in a future version of ACE. Please use ACE_Registry_ImpExp
    * or ACE_Ini_ImpExp instead.
    */
   int import_config (const ACE_TCHAR* filename);
 
   /**
-   * Determine if the contents of this object is the same as the 
+   * Determine if the contents of this object is the same as the
    * contents of the object on the right hand side.
    * Returns 1 (True) if they are equal and 0 (False) if they are not equal
    */
   int operator==(const ACE_Configuration& rhs) const;
 
   /**
-   * Determine if the contents of this object are different from the 
+   * Determine if the contents of this object are different from the
    * contents of the object on the right hand side.
    * Returns 0 (False) if they are equal and 1 (True) if they are not equal
    */
diff --git a/ace/Containers_T.h b/ace/Containers_T.h
index d0c954c14e0..71b62805720 100644
--- a/ace/Containers_T.h
+++ b/ace/Containers_T.h
@@ -494,9 +494,8 @@ public:
   int next (T *&) const;
 
   /**
-   * Return the address of next (current) unvisited item in the list.
-   * 0 if there is no more element available.
-   * DEPRECATED
+   * @deprecated Return the address of next (current) unvisited item in
+   * the list. 0 if there is no more element available.
    */
   T *next (void) const;
 
@@ -1024,10 +1023,9 @@ public:
   int next (T *&);
 
   /**
-   * Delegates to ACE_Double_Linked_List_Iterator, except that whereas
-   * the Double_Linked_List version of next returns the node, this next
+   * @deprecated Delegates to ACE_Double_Linked_List_Iterator, except that
+   * whereas the Double_Linked_List version of next returns the node, this next
    * returns the contents of the node
-   * DEPRECATED
    */
   T *next (void) const;
 
@@ -1085,8 +1083,7 @@ public:
   /// Returns 0 when all items have been seen, else 1.
   int next (T *&);
 
-  /// Delegates to ACE_Double_Linked_List_Iterator.
-  /// DEPRECATED
+  /// @deprecated Delegates to ACE_Double_Linked_List_Iterator.
   T *next (void) const;
 
   /// Removes the current item (i.e., <next>) from the list.
diff --git a/ace/High_Res_Timer.h b/ace/High_Res_Timer.h
index eafa513ebb7..5fa74fa430f 100644
--- a/ace/High_Res_Timer.h
+++ b/ace/High_Res_Timer.h
@@ -236,9 +236,9 @@ public:
   static ACE_Time_Value gettimeofday_hr (void);
 
   /**
-   * THIS FUNCTION IS DEPRECATED.  PLEASE USE <ACE_OS::gettimeofday>
-   * INSTEAD!  Calls <ACE_High_Res_Timer::hrtime_to_tv> passing
-   * <ACE_OS::gethrtime>.  This function can be used to parameterize
+   * @deprecated THIS FUNCTION IS DEPRECATED.  PLEASE USE
+   * <ACE_OS::gettimeofday> INSTEAD!  Calls <ACE_High_Res_Timer::hrtime_to_tv>
+   * passing <ACE_OS::gethrtime>.  This function can be used to parameterize
    * objects such as <ACE_Timer_Queue::gettimeofday>.  If
    * <global_scale_factor_> is not set, and we're on a platform that
    * requires <global_scale_factor_> (e.g., Win32),
diff --git a/ace/Object_Manager.h b/ace/Object_Manager.h
index 620631a6cb6..1524981f5a0 100644
--- a/ace/Object_Manager.h
+++ b/ace/Object_Manager.h
@@ -297,9 +297,9 @@ public:
   // arrays.
 
   /**
-   * Accesses a default signal set used, for example, in ACE_Sig_Guard
-   * methods.
-   * Deprecated:  use ACE_Object_Manager::default_mask () instead.
+   * @deprecated Accesses a default signal set used, for example,
+   * in ACE_Sig_Guard methods.
+   * Deprecated: use ACE_Object_Manager::default_mask () instead.
    */
   static ACE_Sig_Set &default_mask (void);
 
diff --git a/ace/Reactor.h b/ace/Reactor.h
index ef9517c57b5..77e276ef8e6 100644
--- a/ace/Reactor.h
+++ b/ace/Reactor.h
@@ -217,13 +217,15 @@ public:
   /// Use a user specified signal handler instead.
   virtual int set_sig_handler (ACE_Sig_Handler *signal_handler);
 
-  // = The following method is deprecated.  Use <timer_queue> instead.
+  // = The following method is deprecated.
+  /// @deprecated Use <timer_queue> instead.
   /// Set a user specified timer queue.
   virtual int set_timer_queue (ACE_Timer_Queue *tq);
 
   /// Set a user-specified timer queue.
-  /// Return the current <ACE_Timer_Queue>.
   virtual int timer_queue (ACE_Timer_Queue *tq);
+
+  /// Return the current <ACE_Timer_Queue>.
   virtual ACE_Timer_Queue *timer_queue (void) const;
 
   /// Close down and release all resources.
diff --git a/ace/Reactor_Impl.h b/ace/Reactor_Impl.h
index 71c0591f20c..7873b25adf3 100644
--- a/ace/Reactor_Impl.h
+++ b/ace/Reactor_Impl.h
@@ -146,13 +146,14 @@ public:
   /// Use a user specified signal handler instead.
   virtual int set_sig_handler (ACE_Sig_Handler *signal_handler) = 0;
 
-  // = The following method is deprecated.  Use <timer_queue> instead.
+  /// @deprecated The following method is deprecated.  Use <timer_queue> instead.
   /// Set a user specified timer queue.
   virtual int set_timer_queue (ACE_Timer_Queue *tq) = 0;
 
   /// Set a user-specified timer queue.
-  /// Return the current <ACE_Timer_Queue>.
   virtual int timer_queue (ACE_Timer_Queue *tq) = 0;
+
+  /// Return the current <ACE_Timer_Queue>.
   virtual ACE_Timer_Queue *timer_queue (void) const = 0;
 
   /// Close down and release all resources.
diff --git a/ace/Select_Reactor_T.h b/ace/Select_Reactor_T.h
index 4ecaa62d6d2..25cd89a4430 100644
--- a/ace/Select_Reactor_T.h
+++ b/ace/Select_Reactor_T.h
@@ -116,7 +116,7 @@ public:
 
   /// If <disable_notify_pipe> is non-0 then the reactor will
   /// not create a notification pipe, which will save two I/O handles
-  /// but will elide the <notify()> feature.  If <mask_signals> is 
+  /// but will elide the <notify()> feature.  If <mask_signals> is
   /// 1 the reactor is "signal-safe" when dispatching handlers to
   /// signal events, whereas if <mask_signals> is 0 the reactor will
   /// be more efficient, but not signal-safe (which may be perfectly
@@ -131,7 +131,7 @@ public:
   /// Initialize @c ACE_Select_Reactor with size @arg size.
   /// If @arg disable_notify_pipe is non-0 then the reactor will
   /// not create a notification pipe, which will save two I/O handles
-  /// but will elide the notification feature.  If @arg mask_signals is 
+  /// but will elide the notification feature.  If @arg mask_signals is
   /// 1 the reactor is "signal-safe" when dispatching handlers to
   /// signal events, whereas if @arg mask_signals is 0 the reactor will
   /// be more efficient, but not signal-safe (which may be perfectly
@@ -183,13 +183,14 @@ public:
   /// Use a user specified signal handler instead.
   virtual int set_sig_handler (ACE_Sig_Handler *signal_handler);
 
-  // = The following method is deprecated.  Use <timer_queue> instead.
+  /// @deprecated The following method is deprecated.  Use <timer_queue> instead.
   /// Set a user specified timer queue.
   virtual int set_timer_queue (ACE_Timer_Queue *tq);
 
   /// Set a user-specified timer queue.
-  /// Return the current <ACE_Timer_Queue>.
   virtual int timer_queue (ACE_Timer_Queue *tq);
+
+  /// Return the current <ACE_Timer_Queue>.
   virtual ACE_Timer_Queue *timer_queue (void) const;
 
   /// Close down the select_reactor and release all of its resources.
diff --git a/ace/WFMO_Reactor.h b/ace/WFMO_Reactor.h
index 82f43aa43f5..b380aebe21a 100644
--- a/ace/WFMO_Reactor.h
+++ b/ace/WFMO_Reactor.h
@@ -669,7 +669,7 @@ public:
   /// Use a user specified signal handler instead.
   virtual int set_sig_handler (ACE_Sig_Handler *signal_handler);
 
-  // = The following method is deprecated.  Use <timer_queue> instead.
+  /// @deprecated The following method is deprecated.  Use <timer_queue> instead.
   /// Set a user specified timer queue.
   virtual int set_timer_queue (ACE_Timer_Queue *tq);