ChangeLogTag: Fri Apr 16 09:16:11 UTC 2004 Johnny Willemsen <jwillemsen@remedy.nl>

13 files changed, 100 insertions, 130 deletions

diff --git a/TAO/tao/Collocated_Invocation.h b/TAO/tao/Collocated_Invocation.h
index 9278ea97f40..a863ac1e360 100644
--- a/TAO/tao/Collocated_Invocation.h
+++ b/TAO/tao/Collocated_Invocation.h
@@ -39,7 +39,7 @@ namespace TAO
    *
    * @brief Class for Collocated invocations
    *
-   * @NOTE: Reliable oneways are not handled properly including use of
+   * @note Reliable oneways are not handled properly including use of
    * interceptors. This class should technically serve as the base
    * for all invocation types. But now, this is the only class that
    * handles collocated invocations and that too in a brain dead way.
diff --git a/TAO/tao/LocateRequest_Invocation.h b/TAO/tao/LocateRequest_Invocation.h
index 0d8df08b517..8585342818a 100644
--- a/TAO/tao/LocateRequest_Invocation.h
+++ b/TAO/tao/LocateRequest_Invocation.h
@@ -46,13 +46,13 @@ namespace TAO
   {
   public:
     /**
-     * @param target, The target on which this invocation was
+     * @param target The target on which this invocation was
      *  started.
      *
-     * @param resolver, Comntainer of the profile and transport on
+     * @param resolver Container of the profile and transport on
      * which this invocation is on
      *
-     * @param detail, Operation details of the invocation on @a
+     * @param detail Operation details of the invocation on @a
      * target. This is of no practical importance since it is not used
      * in this class. This is just to keep our base class happy.
      *
diff --git a/TAO/tao/ORB.h b/TAO/tao/ORB.h
index 8e586968e86..663b2df30ae 100644
--- a/TAO/tao/ORB.h
+++ b/TAO/tao/ORB.h
@@ -247,7 +247,7 @@ namespace CORBA
     void create_list (CORBA::Long count,
                       CORBA::NVList_ptr &new_list
                       ACE_ENV_ARG_DECL_WITH_DEFAULTS);
-                      
+
     void create_operation_list(CORBA::OperationDef_ptr,
                              CORBA::NVList_ptr&
                              ACE_ENV_ARG_DECL_WITH_DEFAULTS);
@@ -583,7 +583,7 @@ namespace CORBA
 
     /// Set collocation optimization status.
     /// Get collocation optimization status.
-    /// @@todo: Who is calling this?
+    /// @todo Who is calling this?
     void _optimize_collocation_objects (CORBA::Boolean opt);
     CORBA::Boolean _optimize_collocation_objects (void) const;
 
diff --git a/TAO/tao/RTCORBA/RT_Policy_i.h b/TAO/tao/RTCORBA/RT_Policy_i.h
index d12669396a0..a68f25e42da 100644
--- a/TAO/tao/RTCORBA/RT_Policy_i.h
+++ b/TAO/tao/RTCORBA/RT_Policy_i.h
@@ -457,16 +457,17 @@ private:
 
 //*************************************************************************
 
+/**
+ * @class TAO_TCP_Properties
+ *
+ * @brief RTCORBA::TCPProtocolProperties implementation
+ *
+ * Stores TCP Protocol configuration properties.
+ */
 class TAO_RTCORBA_Export TAO_TCP_Properties
   : public RTCORBA::TCPProtocolProperties,
     public TAO_Local_RefCounted_Object
 {
-  // = TITLE
-  //   RTCORBA::TCPProtocolProperties implementation
-  //
-  // = DESCRIPTION
-  //   Stores TCP Protocol configuration properties.
-  //
 public:
   /// Constructor.
   TAO_TCP_Properties (CORBA::Long send_buffer_size =
diff --git a/TAO/tao/RTPortableServer/RTPortableServer.h b/TAO/tao/RTPortableServer/RTPortableServer.h
index 1e2d00db86b..126d686ca47 100644
--- a/TAO/tao/RTPortableServer/RTPortableServer.h
+++ b/TAO/tao/RTPortableServer/RTPortableServer.h
@@ -1,19 +1,13 @@
 /* -*- C++ -*- */
-
-// $Id$
-
-// =========================================================================
-//
-// = LIBRARY
-//    TAO
-//
-// = FILENAME
-//    RTPortableserver.h
-//
-// = AUTHOR
-//    Frank Hunleth <fhunleth@cs.wustl.edu>
-//
-// =========================================================================
+//=============================================================================
+/**
+ *  @file    RTPortableserver.h
+ *
+ *  $Id$
+ *
+ *  @author  Frank Hunleth  <fhuntleth@cs.wustl.edu>
+ */
+//=============================================================================
 
 #ifndef TAO_RT_PORTABLESERVER_H
 #define TAO_RT_PORTABLESERVER_H
@@ -34,7 +28,7 @@
 class TAO_RTPortableServer_Export TAO_RTPortableServer_Initializer
 {
 public:
-  // Constructor.
+  /// Constructor.
   TAO_RTPortableServer_Initializer (void);
 };
 
diff --git a/TAO/tao/RTPortableServer/RTPortableServer.pidl b/TAO/tao/RTPortableServer/RTPortableServer.pidl
index 813df90758e..3e10b14cf66 100644
--- a/TAO/tao/RTPortableServer/RTPortableServer.pidl
+++ b/TAO/tao/RTPortableServer/RTPortableServer.pidl
@@ -1,35 +1,27 @@
-//
-// $Id$
-//
-// ================================================================
-//
-// = LIBRARY
-//   TAO
-//
-// = FILENAME
-//   RTPortableServer.pidl
-//
-// = DESCRIPTION
-//
-//   This file was used to generate the code in RTPortableServerC.{h,i,cpp}
-//   The steps to regenerate the code are as follows:
-//
-//   1. Run the tao_idl compiler on the pidl file.  The command used for
-//   this is:
-//
-//     tao_idl
-//          -o orig -Ge 1 -GT -GA -Sc
-//          -Wb,export_macro=TAO_RTPortableServer_Export
-//          -Wb,export_include="rtportableserver_export.h"
-//          -Wb,pre_include="ace/pre.h"
-//          -Wb,post_include="ace/post.h"
-//          RTPortableServer.pidl
-//
-//   2. Then apply the patches in tao/RTPortableServer/diffs to the
-//   generated code.
-//
-//
-// ================================================================
+/**
+ * @file RTPortableServer.pidl
+ *
+ * $Id$
+ *
+ * @brief Pre-compiled IDL source for the RTPortableServer module.
+ *
+ * This file was used to generate the code in RTPortableServerC.{h,i,cpp}
+ * The steps to regenerate the code are as follows:
+ *
+ *   1. Run the tao_idl compiler on the pidl file.  The command used for
+ *   this is:
+ *
+ *     tao_idl
+ *          -o orig -Ge 1 -GT -GA -Sc
+ *          -Wb,export_macro=TAO_RTPortableServer_Export
+ *          -Wb,export_include="rtportableserver_export.h"
+ *          -Wb,pre_include="ace/pre.h"
+ *          -Wb,post_include="ace/post.h"
+ *          RTPortableServer.pidl
+ *
+ *   2. Then apply the patches in tao/RTPortableServer/diffs to the
+ *   generated code.
+ */
 
 #ifndef _RT_PORTABLE_SERVER_IDL_
 #define _RT_PORTABLE_SERVER_IDL_
diff --git a/TAO/tao/RTPortableServer/RT_Acceptor_Filters.h b/TAO/tao/RTPortableServer/RT_Acceptor_Filters.h
index 6fb6a9d8ce1..438cf3f3b3a 100644
--- a/TAO/tao/RTPortableServer/RT_Acceptor_Filters.h
+++ b/TAO/tao/RTPortableServer/RT_Acceptor_Filters.h
@@ -1,21 +1,15 @@
 // -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//    PortableServer
-//
-// = FILENAME
-//    RT_Acceptor_Filters.h
-//
-// = DESCRIPTION
-//     RTCORBA strategies for populating mprofile.
-//
-// = AUTHOR
-//     Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ *  @file    RT_Acceptor_Filters.h
+ *
+ *  $Id$
+ *
+ *  RTCORBA strategies for populating mprofile.
+ *
+ *  @author  Marina Spivak <marina@cs.wustl.edu>
+ */
+// ===================================================================
 
 #ifndef TAO_RT_ACCEPTOR_FILTER_H
 #define TAO_RT_ACCEPTOR_FILTER_H
@@ -61,7 +55,7 @@ public:
   /// Constructor
   TAO_Server_Protocol_Acceptor_Filter (RTCORBA::ProtocolList &protocols);
 
-  /// Populate <mprofile> based on what's in <protocols_>.
+  /// Populate @a mprofile based on what's in <protocols_>.
   int fill_profile (const TAO::ObjectKey &object_key,
                     TAO_MProfile &mprofile,
                     TAO_Acceptor **acceptors_begin,
diff --git a/TAO/tao/RTPortableServer/RT_Collocation_Resolver.h b/TAO/tao/RTPortableServer/RT_Collocation_Resolver.h
index cd19f7de024..3fe8a0375d7 100644
--- a/TAO/tao/RTPortableServer/RT_Collocation_Resolver.h
+++ b/TAO/tao/RTPortableServer/RT_Collocation_Resolver.h
@@ -39,7 +39,7 @@ class TAO_RTPortableServer_Export TAO_RT_Collocation_Resolver :
 {
 public:
 
-  /// Is <object> collocated?
+  /// Is @a object collocated?
   virtual CORBA::Boolean is_collocated (CORBA::Object_ptr object
                                         ACE_ENV_ARG_DECL) const;
 };
diff --git a/TAO/tao/RTPortableServer/RT_Object_Adapter_Factory.h b/TAO/tao/RTPortableServer/RT_Object_Adapter_Factory.h
index 9f978e3be14..fc7d74d5ca6 100644
--- a/TAO/tao/RTPortableServer/RT_Object_Adapter_Factory.h
+++ b/TAO/tao/RTPortableServer/RT_Object_Adapter_Factory.h
@@ -1,18 +1,13 @@
 /* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//    TAO
-//
-// = FILENAME
-//    RT_Object_Adapter_Factory.h
-//
-// = AUTHOR
-//    Frank Hunleth
-//
-// ============================================================================
+//=============================================================================
+/**
+ *  @file    RT_Object_Adapter_Factory.h
+ *
+ *  $Id$
+ *
+ *  @author  Frank Hunleth
+ */
+// ===================================================================
 
 #ifndef TAO_RT_OBJECT_ADAPTER_FACTORY_H
 #define TAO_RT_OBJECT_ADAPTER_FACTORY_H
@@ -34,8 +29,8 @@
 class TAO_RTPortableServer_Export TAO_RT_Object_Adapter_Factory : public TAO_Object_Adapter_Factory
 {
 public:
+  /// Constructor
   TAO_RT_Object_Adapter_Factory (void);
-  // Constructor
 
   /// Create adapter.
   virtual TAO_Adapter *create (TAO_ORB_Core *orb_core);
diff --git a/TAO/tao/RTPortableServer/RT_POA.h b/TAO/tao/RTPortableServer/RT_POA.h
index 56b0da53add..9fbb2603074 100644
--- a/TAO/tao/RTPortableServer/RT_POA.h
+++ b/TAO/tao/RTPortableServer/RT_POA.h
@@ -1,21 +1,15 @@
-// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//    PortableServer
-//
-// = FILENAME
-//    RT_POA.h
-//
-// = DESCRIPTION
-//     RT_POA
-//
-// = AUTHOR
-//     Irfan Pyarali
-//
-// ============================================================================
+/* -*- C++ -*- */
+//=============================================================================
+/**
+ *  @file    RT_POA.h
+ *
+ *  $Id$
+ *
+ *  RT_POA
+ *
+ *  @author  Irfan Pyarali
+ */
+// ===================================================================
 
 #ifndef TAO_RT_POA_H
 #define TAO_RT_POA_H
@@ -300,8 +294,8 @@ protected:
 
   void validate_policies (ACE_ENV_SINGLE_ARG_DECL);
 
-  // Parse the policy list for RT policies and update our
-  // cached policy instance.
+  /// Parse the policy list for RT policies and update our
+  /// cached policy instance.
   void parse_rt_policies (TAO_POA_Policy_Set &policies
                           ACE_ENV_ARG_DECL);
 
diff --git a/TAO/tao/Server_Strategy_Factory.h b/TAO/tao/Server_Strategy_Factory.h
index 2bdfde3dab2..4ba7d599e9f 100644
--- a/TAO/tao/Server_Strategy_Factory.h
+++ b/TAO/tao/Server_Strategy_Factory.h
@@ -53,29 +53,29 @@ public:
     /// Constructor.
     Active_Object_Map_Creation_Parameters (void);
 
+    /// Default size of object lookup table.
     CORBA::ULong active_object_map_size_;
-    // Default size of object lookup table.
 
+    /// The type of lookup/demultiplexing strategy being used for user
+    /// id policy
     TAO_Demux_Strategy object_lookup_strategy_for_user_id_policy_;
-    // The type of lookup/demultiplexing strategy being used for user
-    // id policy
 
+    /// The type of lookup/demultiplexing strategy being used for
+    /// system id policy
     TAO_Demux_Strategy object_lookup_strategy_for_system_id_policy_;
-    // The type of lookup/demultiplexing strategy being used for
-    // system id policy
 
+    /// The type of reverse lookup/demultiplexing strategy being used
+    /// for the UNIQUE_ID policy
     TAO_Demux_Strategy reverse_object_lookup_strategy_for_unique_id_policy_;
-    // The type of reverse lookup/demultiplexing strategy being used
-    // for the UNIQUE_ID policy
 
+    /// Flag to indicate whether the active hint should be used with
+    /// the IOR.
     int use_active_hint_in_ids_;
-    // Flag to indicate whether the active hint should be used with
-    // the IOR.
 
+    /// Flag to indicate whether reactivations of servants was required
+    /// (under the system id policy).  If not, certain resources may
+    /// not be required.
     int allow_reactivation_of_system_ids_;
-    // Flag to indicate whether reactivations of servants was required
-    // (under the system id policy).  If not, certain resources may
-    // not be required.
 
     CORBA::ULong poa_map_size_;
 
@@ -121,7 +121,7 @@ public:
   virtual int server_connection_thread_count (void);
 
   /// Return the active object map creation parameters.
-  virtual 
+  virtual
   const Active_Object_Map_Creation_Parameters &
   active_object_map_creation_parameters (void) const;
 
diff --git a/TAO/tao/Service_Context.h b/TAO/tao/Service_Context.h
index ca356a5a375..2b745468558 100644
--- a/TAO/tao/Service_Context.h
+++ b/TAO/tao/Service_Context.h
@@ -45,7 +45,7 @@
  * marshalling and unmarshalling information pertaining to service
  * context list
  *
- * Note: Somewhere down the line we may want to use this class for
+ * @note Somewhere down the line we may want to use this class for
  * fast access to the info that we need from the Service Context
  * List.
  */
diff --git a/TAO/tao/operation_details.h b/TAO/tao/operation_details.h
index 96cb992336c..7f217584581 100644
--- a/TAO/tao/operation_details.h
+++ b/TAO/tao/operation_details.h
@@ -47,13 +47,13 @@ namespace TAO
  * infancy now but I expect this one to grow as we come with
  * different varieties of use cases.
  *
- * @@TODO: Put this in namespace TAO.
+ * @todo Put this in namespace TAO.
  */
 class TAO_Export TAO_Operation_Details
 {
 public:
 
-  ///Constructor
+  /// Constructor
   TAO_Operation_Details (const char *name,
                          CORBA::ULong len,
                          CORBA::Boolean argument_flag,