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

1 files changed, 61 insertions, 54 deletions

diff --git a/ace/Registry_Name_Space.h b/ace/Registry_Name_Space.h
index 2c1458a7aa8..439cd14b488 100644
--- a/ace/Registry_Name_Space.h
+++ b/ace/Registry_Name_Space.h
@@ -1,18 +1,15 @@
 /*-*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//    ACE
-//
-// = FILENAME
-//    Registry_Name_Space.h
-//
-// = AUTHOR
-//    Irfan Pyarali (irfan@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ *  @file    Registry_Name_Space.h
+ *
+ *  $Id$
+ *
+ *  @author Irfan Pyarali (irfan@cs.wustl.edu)
+ */
+//=============================================================================
+
 
 #ifndef ACE_REGISTRY_NAME_SPACE_H
 #define ACE_REGISTRY_NAME_SPACE_H
@@ -31,95 +28,105 @@
 #include "ace/Naming_Context.h"
 #include "ace/Name_Space.h"
 
+/**
+ * @class ACE_Registry_Name_Space
+ *
+ * @brief Interface to a Name Server Database which is maintained by
+ * the Win32 Registry.  Allows to add, change, remove and
+ * resolve NameBindings.
+ *
+ * Manages a Naming Service for a registry name space which
+ * includes bindings for all contexts. All strings are stored in
+ * wide character format.  A Name Binding consists of a name
+ * (that's the key), a value string. There is no type string
+ * support in this Name Space.
+ */
 class ACE_Export ACE_Registry_Name_Space : public ACE_Name_Space
 {
-  // = TITLE
-  //     Interface to a Name Server Database which is maintained by
-  //     the Win32 Registry.  Allows to add, change, remove and
-  //     resolve NameBindings.
-  //
-  // = DESCRIPTION
-  //     Manages a Naming Service for a registry name space which
-  //     includes bindings for all contexts. All strings are stored in
-  //     wide character format.  A Name Binding consists of a name
-  //     (that's the key), a value string. There is no type string
-  //     support in this Name Space.
 public:
 
+  /// Constructor
   ACE_Registry_Name_Space (void);
-  // Constructor
 
+  /// Contacts and opens the registry on the specified server
   ACE_Registry_Name_Space (ACE_Name_Options *name_options);
-  // Contacts and opens the registry on the specified server
 
+  /// Destructor
   ~ACE_Registry_Name_Space (void);
-  // Destructor
 
+  /// Contacts and opens the registry on the specified server
   int open (ACE_Name_Options *name_options);
-  // Contacts and opens the registry on the specified server
 
+  /// Bind a new name to a naming context (Wide character strings).
   int bind (const ACE_WString &name_in,
             const ACE_WString &value_in,
             const char *type_in = "");
-  // Bind a new name to a naming context (Wide character strings).
 
+  /**
+   * Overwrite the value or type of an existing name in a
+   * ACE_Name_Space or bind a new name to the context, if it didn't
+   * exist yet. (Wide charcter strings interface).
+   */
   int rebind (const ACE_WString &name_in,
               const ACE_WString &value_in,
               const char *type_in = "");
-  // Overwrite the value or type of an existing name in a
-  // ACE_Name_Space or bind a new name to the context, if it didn't
-  // exist yet. (Wide charcter strings interface).
 
+  /// Delete a name from a ACE_Name_Space (Wide charcter strings
+  /// Interface).
   int unbind (const ACE_WString &name_in);
-  // Delete a name from a ACE_Name_Space (Wide charcter strings
-  // Interface).
 
+  /// Get value and type of a given name binding (Wide chars).  The
+  /// caller is responsible for deleting both <value_out> and <type_out>!
   int resolve (const ACE_WString &name_in,
                ACE_WString &value_out,
                char *&type_out);
-  // Get value and type of a given name binding (Wide chars).  The
-  // caller is responsible for deleting both <value_out> and <type_out>!
 
+  /// Get a set of names matching a specified pattern (wchars). Matching
+  /// means the names must begin with the pattern string.
   int list_names (ACE_WSTRING_SET &set_out,
                   const ACE_WString &pattern_in);
-  // Get a set of names matching a specified pattern (wchars). Matching
-  // means the names must begin with the pattern string.
 
+  /// Get a set of values matching a specified pattern (wchars). Matching
+  /// means the values must begin with the pattern string.
   int list_values (ACE_WSTRING_SET &set_out,
                    const ACE_WString &pattern_in);
-  // Get a set of values matching a specified pattern (wchars). Matching
-  // means the values must begin with the pattern string.
 
+  /// Get a set of types matching a specified pattern (wchars). Matching
+  /// means the types must begin with the pattern string.
   int list_types (ACE_WSTRING_SET &set_out,
                   const ACE_WString &pattern_in);
-  // Get a set of types matching a specified pattern (wchars). Matching
-  // means the types must begin with the pattern string.
 
+  /**
+   * Get a set of names matching a specified pattern (wchars). Matching
+   * means the names must begin with the pattern string. Returns the
+   * complete binding associated each pattern match.
+   */
   int list_name_entries (ACE_BINDING_SET &set,
                          const ACE_WString &pattern);
-  // Get a set of names matching a specified pattern (wchars). Matching
-  // means the names must begin with the pattern string. Returns the
-  // complete binding associated each pattern match.
 
+  /**
+   * Get a set of values matching a specified pattern (wchars). Matching
+   * means the values must begin with the pattern string. Returns the
+   * complete binding associated each pattern match.
+   */
   int list_value_entries (ACE_BINDING_SET &set,
                           const ACE_WString &pattern);
-  // Get a set of values matching a specified pattern (wchars). Matching
-  // means the values must begin with the pattern string. Returns the
-  // complete binding associated each pattern match.
 
+  /**
+   * Get a set of types matching a specified pattern (wchars). Matching
+   * means the types must begin with the pattern string. Returns the
+   * complete binding associated each pattern match.
+   */
   int list_type_entries (ACE_BINDING_SET &set,
                          const ACE_WString &pattern);
-  // Get a set of types matching a specified pattern (wchars). Matching
-  // means the types must begin with the pattern string. Returns the
-  // complete binding associated each pattern match.
 
+  /// Dump the state of the object
   void dump (void) const;
-  // Dump the state of the object
 
 private:
 
+  /// current context
   ACE_Registry::Naming_Context context_;
-  // current context
 };
 
 #endif /* ACE_WIN32 && UNICODE */