ChangeLogTag:Wed Nov 1 14:11:48 2000 Carlos O'Ryan <coryan@uci.edu>

1 files changed, 34 insertions, 31 deletions

diff --git a/ace/UPIPE_Acceptor.h b/ace/UPIPE_Acceptor.h
index fcad01e71d3..d19151370fc 100644
--- a/ace/UPIPE_Acceptor.h
+++ b/ace/UPIPE_Acceptor.h
@@ -1,18 +1,16 @@
 /* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//    ace
-//
-// = FILENAME
-//    UPIPE_Acceptor.h
-//
-// = AUTHOR
-//    Gerhard Lenzer and Douglas C. Schmidt
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ *  @file    UPIPE_Acceptor.h
+ *
+ *  $Id$
+ *
+ *  @author Gerhard Lenzer
+ *  @author Douglas C. Schmidt
+ */
+//=============================================================================
+
 
 #ifndef ACE_UPIPE_ACCEPTOR_H
 #define ACE_UPIPE_ACCEPTOR_H
@@ -30,56 +28,61 @@
 
 #if defined (ACE_HAS_THREADS)
 
+/**
+ * @class ACE_UPIPE_Acceptor
+ *
+ * @brief Defines the format and interface for the listener side of the
+ * ACE_UPIPE_Stream.
+ */
 class ACE_Export ACE_UPIPE_Acceptor : public ACE_SPIPE_Acceptor
 {
-  // = TITLE
-  //     Defines the format and interface for the listener side of the
-  //     ACE_UPIPE_Stream.
 public:
   // = Initialization and termination.
+  /// Default constructor.
   ACE_UPIPE_Acceptor (void);
-  // Default constructor.
 
+  /// Initialize passive endpoint.
   ACE_UPIPE_Acceptor (const ACE_UPIPE_Addr &local_sap,
                       int reuse_addr = 0);
-  // Initialize passive endpoint.
 
+  /// Initialize passive endpoint.
   int open (const ACE_UPIPE_Addr &local_sap,
             int reuse_addr = 0);
-  // Initialize passive endpoint.
 
+  /// Close down and release resources.
   ~ACE_UPIPE_Acceptor (void);
-  // Close down and release resources.
 
+  /// Close down and release resources.
   int close (void);
-  // Close down and release resources.
 
+  /// Close down and release resources and remove the underlying SPIPE
+  /// rendezvous point.
   int remove (void);
-  // Close down and release resources and remove the underlying SPIPE
-  // rendezvous point.
 
   // = Passive connection acceptance method.
+  /**
+   * Accept a new data transfer connection.  A <timeout> of 0 means
+   * block forever, a <timeout> of {0, 0} means poll.  <restart> == 1
+   * means "restart if interrupted."
+   */
   int accept (ACE_UPIPE_Stream &server_stream,
               ACE_UPIPE_Addr *remote_addr = 0,
               ACE_Time_Value *timeout = 0,
               int restart = 1,
               int reset_new_handle = 0);
-  // Accept a new data transfer connection.  A <timeout> of 0 means
-  // block forever, a <timeout> of {0, 0} means poll.  <restart> == 1
-  // means "restart if interrupted."
 
+  /// Dump the state of an object.
   void dump (void) const;
-  // Dump the state of an object.
 
+  /// Declare the dynamic allocation hooks.
   ACE_ALLOC_HOOK_DECLARE;
-  // Declare the dynamic allocation hooks.
 
 private:
+  /// Manage threads.
   ACE_Thread_Manager tm;
-  // Manage threads.
 
+  /// To confirm connection establishment.
   ACE_Message_Block mb_;
-  // To confirm connection establishment.
 };
 
 #if !defined (ACE_LACKS_INLINE_FUNCTIONS)