ChangeLogTag: Wed Mar 28 08:18:00 2001 Craig Rodrigues <crodrigu@bbn.com>

1 files changed, 29 insertions, 28 deletions

diff --git a/TAO/orbsvcs/orbsvcs/AV/MCast.h b/TAO/orbsvcs/orbsvcs/AV/MCast.h
index dd43b45c7d0..745aaa517b4 100644
--- a/TAO/orbsvcs/orbsvcs/AV/MCast.h
+++ b/TAO/orbsvcs/orbsvcs/AV/MCast.h
@@ -1,20 +1,16 @@
 /* -*- C++ -*- */
 
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//   ORBSVCS AVStreams
-//
-// = FILENAME
-//   MCast.h
-//
-// = AUTHOR
-//    Nagarajan Surendran <naga@cs.wustl.edu>
-//
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ *  @file   MCast.h
+ *
+ *  $Id$
+ *
+ *  @author Nagarajan Surendran <naga@cs.wustl.edu>
+ */
+//=============================================================================
+
 
 #ifndef TAO_AV_MCAST_H
 #define TAO_AV_MCAST_H
@@ -27,14 +23,15 @@
 
 class TAO_AV_UDP_MCast_Flow_Handler;
 
+/**
+ * @class TAO_AV_UDP_MCast_Transport
+ * @brief A transport abstraction for Multicast dgram sockets.
+ *        Uses the ACE_SOCK_Dgram_Mcast to send data.
+ */
 class TAO_AV_UDP_MCast_Transport
   :public TAO_AV_Transport
 {
-  // = TITLE
-  //     A transport abstraction for Multicast dgram sockets.
-  //
-  // = DESCRIPTION
-  //     Uses the ACE_SOCK_Dgram_Mcast to send the data.
+
 public:
   TAO_AV_UDP_MCast_Transport (void);
 
@@ -48,52 +45,56 @@ public:
 
   virtual int mtu (void);
 
+  /// Write the complete Message_Block chain to the connection.
   virtual ACE_Addr *get_peer_addr (void);
   virtual ACE_Addr *get_local_addr (void);
   virtual ssize_t send (const ACE_Message_Block *mblk,
                         ACE_Time_Value *s = 0);
-  // Write the complete Message_Block chain to the connection.
 
+  /// Write the contents of the buffer of length len to the connection.
   virtual ssize_t send (const char *buf,
                         size_t len,
                         ACE_Time_Value *s = 0);
-  // Write the contents of the buffer of length len to the connection.
 
+  /// Write the contents of iovcnt iovec's to the connection.
   virtual ssize_t send (const iovec *iov,
                         int iovcnt,
                         ACE_Time_Value *s = 0);
-  // Write the contents of iovcnt iovec's to the connection.
 
+  /// Read len bytes from into buf.
   virtual ssize_t recv (char *buf,
                         size_t len,
                         ACE_Time_Value *s = 0);
-  // Read len bytes from into buf.
 
+  /// Read len bytes from into buf using flags.
   virtual ssize_t recv (char *buf,
                         size_t len,
                         int flags,
                         ACE_Time_Value *s = 0);
-  // Read len bytes from into buf using flags.
 
+  ///  Read received data into the iovec buffers.
   virtual ssize_t recv (iovec *iov,
                         int iovcnt,
                         ACE_Time_Value *s = 0);
-  //  Read received data into the iovec buffers.
 protected:
   TAO_AV_UDP_MCast_Flow_Handler *handler_;
   ACE_INET_Addr peer_addr_;
   ACE_INET_Addr local_addr_;
 };
 
+/**
+ * @class TAO_AV_UDP_MCast_Flow_Handler
+ * @brief Flow Handler for data sent over multicast sockets.
+ */
 class TAO_AV_UDP_MCast_Flow_Handler
   :public virtual TAO_AV_Flow_Handler,
    public virtual ACE_Event_Handler
 {
 public:
+  /// Ctor
+  /// Dtor
   TAO_AV_UDP_MCast_Flow_Handler (void);
-  // Ctor
   ~TAO_AV_UDP_MCast_Flow_Handler (void);
-  // Dtor
   virtual ACE_HANDLE get_handle (void) const;
   virtual int handle_input (ACE_HANDLE fd);
   virtual int handle_timeout (const ACE_Time_Value &tv, const void *arg = 0);