ChangeLogTag: Fri Apr 12 14:58:12 2002 Johnny Willemsen <jwillemsen@remedy.nl>

1 files changed, 8 insertions, 6 deletions

diff --git a/ace/Timer_Heap_T.h b/ace/Timer_Heap_T.h
index 0b6833d9976..60f64211df2 100644
--- a/ace/Timer_Heap_T.h
+++ b/ace/Timer_Heap_T.h
@@ -182,12 +182,14 @@ public:
   /// Returns a pointer to this <ACE_Timer_Queue>'s iterator.
   virtual ACE_Timer_Queue_Iterator_T<TYPE, FUNCTOR, ACE_LOCK> &iter (void);
 
-  /// Removes the earliest node from the queue and returns it. Note that
-  /// the timer is removed from the heap, but is not freed, and its ID
-  /// is not reclaimed. The caller is responsible for calling either
-  /// @c reschedule or @c free_node after this function returns. Thus,
-  /// this function is for support of @c ACE_Timer_Queue::expire and
-  /// should not be used unadvisedly in other conditions.
+  /**
+   * Removes the earliest node from the queue and returns it. Note that
+   * the timer is removed from the heap, but is not freed, and its ID
+   * is not reclaimed. The caller is responsible for calling either
+   * @c reschedule or @c free_node after this function returns. Thus,
+   * this function is for support of @c ACE_Timer_Queue::expire and
+   * should not be used unadvisedly in other conditions.
+   */
   ACE_Timer_Node_T <TYPE> *remove_first (void);
 
   /// Dump the state of an object.