ChangeLogTag:Fri Dec 15 11:36:08 2000 Carlos O'Ryan <coryan@uci.edu>

1 files changed, 29 insertions, 30 deletions

diff --git a/TAO/tao/Protocol_Factory.h b/TAO/tao/Protocol_Factory.h
index 054de6bb945..6f3a1bca48c 100644
--- a/TAO/tao/Protocol_Factory.h
+++ b/TAO/tao/Protocol_Factory.h
@@ -1,19 +1,16 @@
 // -*- C++ -*-
-// $Id$
-
-
-// ============================================================================
-//
-// = LIBRARY
-//   TAO
-//
-// = FILENAME
-//   Protocol_Factory.h
-//
-// = AUTHOR
-//   Fred Kuhns <fredk@cs.wustl.edu>
-//
-// ============================================================================
+
+
+//=============================================================================
+/**
+ *  @file   Protocol_Factory.h
+ *
+ *  $Id$
+ *
+ *  @author Fred Kuhns <fredk@cs.wustl.edu>
+ */
+//=============================================================================
+
 
 #ifndef TAO_PROTOCOL_FACTORY_H
 #define TAO_PROTOCOL_FACTORY_H
@@ -37,40 +34,42 @@ public:
   TAO_Protocol_Factory (CORBA::ULong tag);
   virtual ~TAO_Protocol_Factory (void);
 
+  /// Initialization hook.
   virtual int init (int argc, char *argv[]);
-  // Initialization hook.
 
+  /// The protocol tag, each concrete class will have a specific tag
+  /// value.
   CORBA::ULong tag (void) const;
-  // The protocol tag, each concrete class will have a specific tag
-  // value.
 
+  /// Verify prefix is a match
   virtual int match_prefix (const ACE_CString &prefix);
-  // Verify prefix is a match
 
+  /// Returns the prefix used by the protocol.
   virtual const char *prefix (void) const;
-  // Returns the prefix used by the protocol.
 
+  /// Return the character used to mark where an endpoint ends and
+  /// where its options begin.
   virtual char options_delimiter (void) const;
-  // Return the character used to mark where an endpoint ends and
-  // where its options begin.
 
   // Factory methods
+  /// Create an acceptor
   virtual TAO_Acceptor  *make_acceptor (void);
-  // Create an acceptor
 
+  /// Create a connector
   virtual TAO_Connector *make_connector  (void);
-  // Create a connector
 
+  /**
+   * Some protocols should not create a default endpoint unless the
+   * user specifies a -ORBEndpoint option. For example, local IPC
+   * (aka UNIX domain sockets) is unable to remove the rendesvouz
+   * point if the server crashes.  For those protocols is better to
+   * create the endpoint only if the user requests one.
+   */
   virtual int requires_explicit_endpoint (void) const = 0;
-  // Some protocols should not create a default endpoint unless the
-  // user specifies a -ORBEndpoint option. For example, local IPC
-  // (aka UNIX domain sockets) is unable to remove the rendesvouz
-  // point if the server crashes.  For those protocols is better to
-  // create the endpoint only if the user requests one.
 
 private:
+  /// IOP protocol tag.
   CORBA::ULong tag_;
-  // IOP protocol tag.
 };
 
 #include "ace/post.h"