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

1 files changed, 56 insertions, 50 deletions

diff --git a/ace/FILE_IO.h b/ace/FILE_IO.h
index d390c0cb5ce..155d1f9a0c4 100644
--- a/ace/FILE_IO.h
+++ b/ace/FILE_IO.h
@@ -1,18 +1,15 @@
 /* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//    ace
-//
-// = FILENAME
-//    FILE_IO.h
-//
-// = AUTHOR
-//    Doug Schmidt
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ *  @file    FILE_IO.h
+ *
+ *  $Id$
+ *
+ *  @author Doug Schmidt
+ */
+//=============================================================================
+
 
 #ifndef ACE_FILE_IO_H
 #define ACE_FILE_IO_H
@@ -29,109 +26,118 @@
 // Used in the FILE_IO.h file...
 #include "ace/ACE.h"
 
+/**
+ * @class ACE_FILE_IO
+ *
+ * @brief Read/Write operations on Files
+ */
 class ACE_Export ACE_FILE_IO : public ACE_FILE
 {
-  // = TITLE
-  //     Read/Write operations on Files
 public:
   friend class ACE_FILE_Connector;
 
   // = Initialization method.
+  /// Default constructor.
   ACE_FILE_IO (void);
-  // Default constructor.
 
+  /// send upto <n> bytes in <buf>.
   ssize_t send (const void *buf, size_t n) const;
-  // send upto <n> bytes in <buf>.
 
+  /// Recv upto <n> bytes in <buf>.
   ssize_t recv (void *buf, size_t n) const;
-  // Recv upto <n> bytes in <buf>.
 
+  /// Send n bytes, keep trying until n are sent.
   ssize_t send_n (const void *buf, size_t n) const;
-  // Send n bytes, keep trying until n are sent.
 
+  /// Recv n bytes, keep trying until n are received.
   ssize_t recv_n (void *buf, size_t n) const;
-  // Recv n bytes, keep trying until n are received.
 
 #if defined (ACE_HAS_STREAM_PIPES)
+  /// Send bytes via STREAM pipes.
   ssize_t send (const ACE_Str_Buf *cntl,
                 const ACE_Str_Buf *data,
                 int flags = 0) const;
-  // Send bytes via STREAM pipes.
 
+  /// Recv bytes via STREAM pipes.
   ssize_t recv (ACE_Str_Buf *cntl,
                 ACE_Str_Buf *data,
                 int *flags) const;
-  // Recv bytes via STREAM pipes.
 
+  /// Send bytes via STREAM pipes using "band" mode.
   ssize_t send (const ACE_Str_Buf *cntl,
                 const ACE_Str_Buf *data,
                 int band,
                 int flags) const;
-  // Send bytes via STREAM pipes using "band" mode.
 
+  /// Recv bytes via STREAM pipes using "band" mode.
   ssize_t recv (ACE_Str_Buf *cntl,
                 ACE_Str_Buf *data,
                 int *band,
                 int *flags) const;
-  // Recv bytes via STREAM pipes using "band" mode.
 
 #endif /* ACE_HAS_STREAM_PIPES */
 
+  /// Send iovecs via <::writev>.
   ssize_t send (const iovec iov[], size_t n) const;
-  // Send iovecs via <::writev>.
 
+  /// Recv iovecs via <::readv>.
   ssize_t recv (iovec iov[], size_t n) const;
-  // Recv iovecs via <::readv>.
 
+  /**
+   * Send N char *ptrs and int lengths.  Note that the char *'s
+   * precede the ints (basically, an varargs version of writev).  The
+   * count N is the *total* number of trailing arguments, *not* a
+   * couple of the number of tuple pairs!
+   */
   ssize_t send (size_t n, ...) const;
-  // Send N char *ptrs and int lengths.  Note that the char *'s
-  // precede the ints (basically, an varargs version of writev).  The
-  // count N is the *total* number of trailing arguments, *not* a
-  // couple of the number of tuple pairs!
 
+  /**
+   * This is an interface to ::readv, that doesn't use the struct
+   * iovec explicitly.  The ... can be passed as an arbitrary number
+   * of (char *ptr, int len) tuples.  However, the count N is the
+   * *total* number of trailing arguments, *not* a couple of the
+   * number of tuple pairs!
+   */
   ssize_t recv (size_t n, ...) const;
-  // This is an interface to ::readv, that doesn't use the struct
-  // iovec explicitly.  The ... can be passed as an arbitrary number
-  // of (char *ptr, int len) tuples.  However, the count N is the
-  // *total* number of trailing arguments, *not* a couple of the
-  // number of tuple pairs!
 
+  /// Send <n> bytes via Win32 WriteFile using overlapped I/O.
   ssize_t send (const void *buf,
                 size_t n,
                 ACE_OVERLAPPED *overlapped) const;
-  // Send <n> bytes via Win32 WriteFile using overlapped I/O.
 
+  /// Recv <n> bytes via Win32 ReadFile using overlapped I/O.
   ssize_t recv (void *buf,
                 size_t n,
                 ACE_OVERLAPPED *overlapped) const;
-  // Recv <n> bytes via Win32 ReadFile using overlapped I/O.
 
+  /// Send an <iovec> of size <n> to the file.
   ssize_t sendv (const iovec iov[],
                  size_t n) const;
-  // Send an <iovec> of size <n> to the file.
 
+  /**
+   * Allows a client to read from a file without having to provide a
+   * buffer to read.  This method determines how much data is in the
+   * file, allocates a buffer of this size, reads in the data, and
+   * returns the number of bytes read.  The caller is responsible for
+   * deleting the member in the <iov_base> field of <io_vec> using
+   * delete [] io_vec->iov_base.
+   */
   ssize_t recvv (iovec *io_vec);
-  // Allows a client to read from a file without having to provide a
-  // buffer to read.  This method determines how much data is in the
-  // file, allocates a buffer of this size, reads in the data, and
-  // returns the number of bytes read.  The caller is responsible for
-  // deleting the member in the <iov_base> field of <io_vec> using
-  // delete [] io_vec->iov_base.
 
+  /// Send an <iovec> of size <n> to the file.  Will block until all
+  /// bytes are sent or an error occurs.
   ssize_t sendv_n (const iovec iov[],
                    size_t n) const;
-  // Send an <iovec> of size <n> to the file.  Will block until all
-  // bytes are sent or an error occurs.
 
+  /// Receive an <iovec> of size <n> to the file.
   ssize_t recvv_n (iovec iov[],
                    size_t n) const;
-  // Receive an <iovec> of size <n> to the file.
 
+  /// 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.
 
   // = Meta-type info
   typedef ACE_FILE_Addr PEER_ADDR;