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

1 files changed, 43 insertions, 37 deletions

diff --git a/ace/IO_Cntl_Msg.h b/ace/IO_Cntl_Msg.h
index 8e8e4380dd9..549becfa70d 100644
--- a/ace/IO_Cntl_Msg.h
+++ b/ace/IO_Cntl_Msg.h
@@ -1,88 +1,94 @@
 /* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//    ace
-//
-// = FILENAME
-//    IO_Cntl_Msg.h
-//
-// = AUTHOR
-//    Doug Schmidt
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ *  @file    IO_Cntl_Msg.h
+ *
+ *  $Id$
+ *
+ *  @author Doug Schmidt
+ */
+//=============================================================================
+
 
 #ifndef ACE_IO_CNTL_MSG_H
 #define ACE_IO_CNTL_MSG_H
 #include "ace/pre.h"
 
+/**
+ * @class ACE_IO_Cntl_Msg
+ *
+ * @brief Data format for IOCTL messages
+ */
 class ACE_Export ACE_IO_Cntl_Msg
 {
-  // = TITLE
-  //     Data format for IOCTL messages
 public:
   enum
   {
-    SET_LWM    = 1, // Set the low water mark.
-    GET_LWM    = 2, // Get the low water mark.
-    SET_HWM    = 3, // Set the high water mark.
-    GET_HWM    = 4, // Get the high water mark.
-    MOD_LINK   = 5, // Link modules
-    MOD_UNLINK = 6  // Unlink modules
+    /// Set the low water mark.
+    SET_LWM    = 1,
+    /// Get the low water mark.
+    GET_LWM    = 2,
+    /// Set the high water mark.
+    SET_HWM    = 3,
+    /// Get the high water mark.
+    GET_HWM    = 4,
+    /// Link modules
+    MOD_LINK   = 5,
+    /// Unlink modules
+    MOD_UNLINK = 6 
   };
 
   typedef u_short ACE_IO_Cntl_Cmds;
 
   // = Initialization method.
+  /// Initialize the control message.
   ACE_IO_Cntl_Msg (ACE_IO_Cntl_Cmds c) { this->cmd_ = c; }
-  // Initialize the control message.
 
   // = Get/set methods
 
+  /// Get command.
   ACE_IO_Cntl_Cmds cmd (void) { return this->cmd_; }
-  // Get command.
 
+  /// Set command.
   void cmd (ACE_IO_Cntl_Cmds c) { this->cmd_ = c; }
-  // Set command.
 
+  /// Get count.
   size_t count (void) { return this->count_; }
-  // Get count.
 
+  /// Set count.
   void count (size_t c) { this->count_ = c; }
-  // Set count.
 
+  /// Get error.
   int error (void) { return this->error_; }
-  // Get error.
 
+  /// Set error.
   void error (int e) { this->error_ = e; }
-  // Set error.
 
+  /// Get return value.
   int rval (void) { return this->rval_; }
-  // Get return value.
 
+  /// Set return value.
   void rval (int r) { this->rval_ = r; }
-  // Set return value.
 
+  /// 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:
+  /// Command.
   ACE_IO_Cntl_Cmds cmd_;
-  // Command.
 
+  /// Count.
   size_t count_;
-  // Count.
 
+  /// Error.
   int error_;
-  // Error.
 
+  /// Return value
   int rval_;
-  // Return value
 };
 
 #include "ace/post.h"