ChangeLogTag: Mon Jun 28 10:29:31 UTC 2004 Johnny Willemsen <jwillemsen@remedy.nl>

9 files changed, 61 insertions, 68 deletions

diff --git a/TAO/tao/Connector_Registry.h b/TAO/tao/Connector_Registry.h
index 4e7dec6c18d..28bb89cd2a5 100644
--- a/TAO/tao/Connector_Registry.h
+++ b/TAO/tao/Connector_Registry.h
@@ -77,7 +77,7 @@ public:
                      TAO_MProfile &mprofile
                      ACE_ENV_ARG_DECL);
 
-  /// Create a profile based on the contents of <cdr>
+  /// Create a profile based on the contents of @a cdr
   TAO_Profile* create_profile (TAO_InputCDR& cdr);
 
   /// Obtain the object key delimiter used by the protocol specified in
diff --git a/TAO/tao/GIOP_Message_Base.h b/TAO/tao/GIOP_Message_Base.h
index 08fe733f941..d4142a28fdc 100644
--- a/TAO/tao/GIOP_Message_Base.h
+++ b/TAO/tao/GIOP_Message_Base.h
@@ -45,8 +45,6 @@ class TAO_Queued_Data;
 class TAO_Export TAO_GIOP_Message_Base : public TAO_Pluggable_Messaging
 {
 public:
-  //  friend class TAO_GIOP_Message_Reactive_Handler;
-
   /// Constructor
   TAO_GIOP_Message_Base (TAO_ORB_Core *orb_core,
                          size_t input_cdr_size = ACE_CDR::DEFAULT_BUFSIZE);
@@ -68,7 +66,7 @@ public:
                                        TAO_Target_Specification &spec,
                                        TAO_OutputCDR &cdr);
 
-  /// Write the RequestHeader in to the <cdr> stream.
+  /// Write the RequestHeader in to the @a cdr stream.
   virtual int generate_locate_request_header (
       TAO_Operation_Details &op,
       TAO_Target_Specification &spec,
@@ -83,7 +81,7 @@ public:
 
   /// This method reads the message on the connection. Returns 0 when
   /// there is short read on the connection. Returns 1 when the full
-  /// message is read and handled. Returns -1 on errors. If <block> is
+  /// message is read and handled. Returns -1 on errors. If @a block is
   /// 1, then reply is read in a blocking manner.
   virtual int read_message (TAO_Transport *transport,
                             int block = 0,
@@ -102,18 +100,18 @@ public:
   /// message block.
   virtual ssize_t missing_data (ACE_Message_Block &message_block);
 
-  /* Extract the details of the next message from the <incoming>
-   * through <qd>. Returns 1 if there are more messages and returns a
-   * 0 if there are no more messages in <incoming>.
+  /* Extract the details of the next message from the @a incoming
+   * through @a qd. Returns 1 if there are more messages and returns a
+   * 0 if there are no more messages in @a incoming.
    */
   virtual int extract_next_message (ACE_Message_Block &incoming,
                                     TAO_Queued_Data *&qd);
 
-  /// Check whether the node <qd> needs consolidation from <incoming>
+  /// Check whether the node @a qd needs consolidation from @a incoming.
   virtual int consolidate_node (TAO_Queued_Data *qd,
                                 ACE_Message_Block &incoming);
 
-  /// Get the details of the message parsed through the <qd>.
+  /// Get the details of the message parsed through the @a qd.
   virtual void get_message_data (TAO_Queued_Data *qd);
 
   /// @@Bala:Docu??
@@ -127,14 +125,12 @@ public:
 
 
   /// Parse the reply message that we received and return the reply
-  /// information though <reply_info>
+  /// information through @a reply_info
   virtual int process_reply_message (
       TAO_Pluggable_Reply_Params &reply_info,
       TAO_Queued_Data *qd);
 
-
-
-  /// Generate a reply message with the exception <ex>.
+  /// Generate a reply message with the exception @a ex.
   virtual int generate_exception_reply (
       TAO_OutputCDR &cdr,
       TAO_Pluggable_Reply_Params_Base &params,
@@ -147,13 +143,13 @@ public:
   virtual TAO_OutputCDR &out_stream (void);
 protected:
 
-  /// Processes the <GIOP_REQUEST> messages
+  /// Processes the GIOP_REQUEST messages
   int process_request (TAO_Transport *transport,
                        TAO_InputCDR &input,
                        TAO_OutputCDR &output,
                        TAO_GIOP_Message_Generator_Parser *);
 
-  /// Processes the <GIOP_LOCATE_REQUEST> messages
+  /// Processes the GIOP_LOCATE_REQUEST messages
   int process_locate_request (TAO_Transport *transport,
                               TAO_InputCDR &input,
                               TAO_OutputCDR &output,
@@ -179,15 +175,15 @@ protected:
 
 private:
 
-  /// Writes the GIOP header in to <msg>
-  /// NOTE: If the GIOP header happens to change in the future, we can
+  /// Writes the GIOP header in to @a msg
+  /// @note If the GIOP header happens to change in the future, we can
   /// push this method in to the generator_parser classes.
   int write_protocol_header (TAO_GIOP_Message_Type t,
                              TAO_OutputCDR &msg);
 
-  /// Make a <GIOP_LOCATEREPLY> and hand that over to the transport so
+  /// Make a GIOP_LOCATEREPLY and hand that over to the transport so
   /// that it can be sent over the connection.
-  /// NOTE:As on date 1.1 & 1.2 seem to have similar headers. Till an
+  /// @note As on date 1.1 & 1.2 seem to have similar headers. Till an
   /// unmanageable difference comes let them be implemented here.
   int make_send_locate_reply (TAO_Transport *transport,
                               TAO_GIOP_Locate_Request_Header &request,
@@ -203,7 +199,7 @@ private:
                               TAO_Transport *transport,
                               void *ctx);
 
-  /// We must send a LocateReply through <transport>, this request
+  /// We must send a LocateReply through @a transport, this request
   /// resulted in some kind of exception.
   int send_reply_exception (TAO_Transport *transport,
                             TAO_OutputCDR &cdr,
@@ -222,15 +218,14 @@ private:
   virtual int is_ready_for_bidirectional (TAO_OutputCDR &msg);
 
   /// Creates a new node for the queue with a message block in the
-  /// node of size <sz>..
+  /// node of size @a sz.
   TAO_Queued_Data *make_queued_data (size_t sz);
 
 private:
-
   /// Cached ORB_Core pointer...
   TAO_ORB_Core *orb_core_;
 
-  /// Thr message handler object that does reading and parsing of the
+  /// The message handler object that does reading and parsing of the
   /// incoming messages
   TAO_GIOP_Message_State message_state_;
 
@@ -238,9 +233,6 @@ private:
   TAO_GIOP_Message_Generator_Parser_Impl tao_giop_impl_;
 
 protected:
-  /// The generator and parser state.
-  // TAO_GIOP_Message_Generator_Parser *generator_parser_;
-
   /// Buffer used for both the output and input CDR streams, this is
   /// "safe" because we only one of the streams at a time.
   char buffer_[ACE_CDR::DEFAULT_BUFSIZE];
diff --git a/TAO/tao/GIOP_Message_Generator_Parser.h b/TAO/tao/GIOP_Message_Generator_Parser.h
index f66d1fd13d1..eef8198c352 100644
--- a/TAO/tao/GIOP_Message_Generator_Parser.h
+++ b/TAO/tao/GIOP_Message_Generator_Parser.h
@@ -46,7 +46,7 @@ class TAO_Export TAO_GIOP_Message_Generator_Parser
 {
 public:
 
-  /// Write the request header in to <msg>
+  /// Write the request header in to @a msg
   virtual int write_request_header (
       const TAO_Operation_Details &opdetails,
       TAO_Target_Specification &spec,
@@ -58,14 +58,14 @@ public:
       TAO_Target_Specification &spec,
       TAO_OutputCDR &msg) = 0;
 
-  /// Write the reply header in to <output>
+  /// Write the reply header in to @a output
   virtual int write_reply_header (
       TAO_OutputCDR &output,
       TAO_Pluggable_Reply_Params_Base &reply
       ACE_ENV_ARG_DECL)
     ACE_THROW_SPEC ((CORBA::SystemException)) = 0;
 
-  /// Writes the locate _reply message in to the <output>
+  /// Writes the locate _reply message in to the @a output
   virtual int write_locate_reply_mesg (
       TAO_OutputCDR &output,
       CORBA::ULong request_id,
diff --git a/TAO/tao/GIOP_Message_Generator_Parser_10.h b/TAO/tao/GIOP_Message_Generator_Parser_10.h
index 94b82bae401..6c78ad72163 100644
--- a/TAO/tao/GIOP_Message_Generator_Parser_10.h
+++ b/TAO/tao/GIOP_Message_Generator_Parser_10.h
@@ -35,7 +35,7 @@ class TAO_Export TAO_GIOP_Message_Generator_Parser_10:
 {
 public:
 
-  /// Write the request header in to <msg>
+  /// Write the request header in to @a msg
   virtual int write_request_header (
       const TAO_Operation_Details &opdetails,
       TAO_Target_Specification &spec,
@@ -49,7 +49,7 @@ public:
       TAO_OutputCDR &msg
     );
 
-  /// Write the reply header in to <output>
+  /// Write the reply header in to @a output
   virtual int write_reply_header (
       TAO_OutputCDR &output,
       TAO_Pluggable_Reply_Params_Base &reply
@@ -57,7 +57,7 @@ public:
     )
     ACE_THROW_SPEC ((CORBA::SystemException));
 
-  /// Writes the locate _reply message in to the <output>
+  /// Writes the locate _reply message in to the @a output
   virtual int write_locate_reply_mesg (
       TAO_OutputCDR &output,
       CORBA::ULong request_id,
diff --git a/TAO/tao/GIOP_Message_Generator_Parser_12.h b/TAO/tao/GIOP_Message_Generator_Parser_12.h
index 47f0e546ba4..bfc2de68785 100644
--- a/TAO/tao/GIOP_Message_Generator_Parser_12.h
+++ b/TAO/tao/GIOP_Message_Generator_Parser_12.h
@@ -104,7 +104,7 @@ private:
   /// Check whether we have BiDirContext info available. If available
   /// delegate  the responsibility on to the TAO_Transport classes to
   /// initiate action.
-  /// Note: At somepoint this may be needed for future versions of
+  /// @note At somepoint this may be needed for future versions of
   /// GIOP and we may have to share this
   int check_bidirectional_context (TAO_ServerRequest &);
 
diff --git a/TAO/tao/GIOP_Message_Lite.h b/TAO/tao/GIOP_Message_Lite.h
index 287ce11008d..54c9ff7aea0 100644
--- a/TAO/tao/GIOP_Message_Lite.h
+++ b/TAO/tao/GIOP_Message_Lite.h
@@ -60,13 +60,13 @@ public:
   /// Reset the messaging the object
   virtual void reset (void);
 
-  /// Write the RequestHeader in to the <cdr> stream. The underlying
+  /// Write the RequestHeader in to the @a cdr stream. The underlying
   /// implementation of the mesaging should do the right thing.
   virtual int generate_request_header (TAO_Operation_Details &op,
                                        TAO_Target_Specification &spec,
                                        TAO_OutputCDR &cdr);
 
-  /// Write the RequestHeader in to the <cdr> stream.
+  /// Write the RequestHeader in to the @a cdr stream.
   virtual int generate_locate_request_header (
       TAO_Operation_Details &op,
       TAO_Target_Specification &spec,
@@ -105,14 +105,14 @@ public:
   /// message block.
   virtual ssize_t missing_data (ACE_Message_Block &message_block);
 
-  /* Extract the details of the next message from the <incoming>
-   * through <qd>. Returns 1 if there are more messages and returns a
-   * 0 if there are no more messages in <incoming>.
+  /* Extract the details of the next message from the @a incoming
+   * through @a qd. Returns 1 if there are more messages and returns a
+   * 0 if there are no more messages in @a incoming.
    */
   virtual int extract_next_message (ACE_Message_Block &incoming,
                                     TAO_Queued_Data *&qd);
 
-  /// Check whether the node <qd> needs consolidation from <incoming>
+  /// Check whether the node @a qd needs consolidation from @a incoming
   virtual int consolidate_node (TAO_Queued_Data *qd,
                                 ACE_Message_Block &incoming);
 
@@ -129,12 +129,12 @@ public:
                                        TAO_Queued_Data *qd);
 
   /// Parse the reply message that we received and return the reply
-  /// information though <reply_info>
+  /// information through @a reply_info
   virtual int process_reply_message (
       TAO_Pluggable_Reply_Params &reply_info,
       TAO_Queued_Data *qd);
 
-  /// Generate a reply message with the exception <ex>.
+  /// Generate a reply message with the exception @a ex.
   virtual int generate_exception_reply (
       TAO_OutputCDR &cdr,
       TAO_Pluggable_Reply_Params_Base &params,
@@ -143,25 +143,25 @@ public:
 
 private:
 
-  /// Writes the GIOP header in to <msg>
-  /// NOTE: If the GIOP header happens to change in the future, we can
+  /// Writes the GIOP header in to @a msg
+  /// @note If the GIOP header happens to change in the future, we can
   /// push this method in to the generator_parser classes.
   int write_protocol_header (TAO_GIOP_Message_Type t,
                              TAO_OutputCDR &msg);
 
-  /// Processes the <GIOP_REQUEST> messages
+  /// Processes the GIOP_REQUEST messages
   int process_request (TAO_Transport *transport,
                        TAO_InputCDR &input,
                        TAO_OutputCDR &output);
 
-  /// Processes the <GIOP_LOCATE_REQUEST> messages
+  /// Processes the GIOP_LOCATE_REQUEST messages
   int process_locate_request (TAO_Transport *transport,
                               TAO_InputCDR &input,
                               TAO_OutputCDR &output);
 
-  /// Make a <GIOP_LOCATEREPLY> and hand that over to the transport so
+  /// Make a GIOP_LOCATEREPLY and hand that over to the transport so
   /// that it can be sent over the connection.
-  /// NOTE:As on date 1.1 & 1.2 seem to have similar headers. Till an
+  /// @note As on date 1.1 & 1.2 seem to have similar headers. Till an
   /// unmanageable difference comes let them be implemented here.
   int make_send_locate_reply (TAO_Transport *transport,
                               TAO_OutputCDR &output,
@@ -176,7 +176,7 @@ private:
                               TAO_Transport *transport,
                               void *ctx);
 
-  /// We must send a LocateReply through <transport>, this request
+  /// We must send a LocateReply through @a transport, this request
   /// resulted in some kind of exception.
   int send_reply_exception (TAO_Transport *transport,
                             TAO_ORB_Core* orb_core,
diff --git a/TAO/tao/Pluggable_Messaging.h b/TAO/tao/Pluggable_Messaging.h
index 8ac38de01e0..c47d1101c9d 100644
--- a/TAO/tao/Pluggable_Messaging.h
+++ b/TAO/tao/Pluggable_Messaging.h
@@ -69,14 +69,14 @@ public:
   /// Dtor
   virtual ~TAO_Pluggable_Messaging (void);
 
-  /// Write the RequestHeader in to the <cdr> stream. The underlying
+  /// Write the RequestHeader in to the @a cdr stream. The underlying
   /// implementation of the mesaging should do the right thing.
   virtual int generate_request_header (
       TAO_Operation_Details &op,
       TAO_Target_Specification &spec,
       TAO_OutputCDR &cdr) = 0;
 
-  /// Write the RequestHeader in to the <cdr> stream.
+  /// Write the RequestHeader in to the @a cdr stream.
   virtual int generate_locate_request_header (
       TAO_Operation_Details &op,
       TAO_Target_Specification &spec,
@@ -105,15 +105,14 @@ public:
   /**
    * This method reads the message on the connection. Returns 0 when
    * there is short read on the connection. Returns 1 when the full
-   * message is read and handled. Returns -1 on errors. If <block> is
-   * 1, then reply is read in a blocking manner. <bytes> indicates the
-   * number of bytes that needs to be read from the connection.
+   * message is read and handled. Returns -1 on errors. If @a block is
+   * 1, then reply is read in a blocking manner.
    */
   virtual int read_message (TAO_Transport *transport,
                             int block = 0,
                             ACE_Time_Value *max_wait_time = 0) = 0;
 
-  /// Format the message in the <cdr>. May not be needed in
+  /// Format the message in the @a cdr. May not be needed in
   /// general.
   virtual int format_message (TAO_OutputCDR &cdr) = 0;
 
@@ -124,21 +123,21 @@ public:
   /// Parse the incoming messages..
   virtual int parse_incoming_messages (ACE_Message_Block &message_block) = 0;
 
-  /// Calculate the amount of data that is missing in the <incoming>
+  /// Calculate the amount of data that is missing in the @a incoming
   /// message block.
   virtual ssize_t missing_data (ACE_Message_Block &incoming) = 0;
 
-  /// Get the details of the message parsed through the <qd>.
+  /// Get the details of the message parsed through the @a qd.
   virtual void get_message_data (TAO_Queued_Data *qd) = 0;
 
-  /* Extract the details of the next message from the <incoming>
-   * through <qd>. Returns 1 if there are more messages and returns a
-   * 0 if there are no more messages in <incoming>.
+  /* Extract the details of the next message from the @a incoming
+   * through @a qd. Returns 1 if there are more messages and returns a
+   * 0 if there are no more messages in @a incoming.
   */
   virtual int extract_next_message (ACE_Message_Block &incoming,
                                     TAO_Queued_Data *&qd) = 0;
 
-  /// Check whether the node <qd> needs consolidation from <incoming>
+  /// Check whether the node @a qd needs consolidation from @a incoming
   virtual int consolidate_node (TAO_Queued_Data *qd,
                                 ACE_Message_Block &incoming) = 0;
 
@@ -153,17 +152,17 @@ public:
 
 
   /// Parse the reply message that we received and return the reply
-  /// information though <reply_info>
+  /// information through @a reply_info
   virtual int process_reply_message (
       TAO_Pluggable_Reply_Params &reply_info,
       TAO_Queued_Data *qd) = 0;
 
 
-  /// Generate a reply message with the exception <ex>.
+  /// Generate a reply message with the exception @a ex.
   virtual int generate_exception_reply (
       TAO_OutputCDR &cdr,
       TAO_Pluggable_Reply_Params_Base &params,
-      CORBA::Exception &x) = 0;
+      CORBA::Exception &ex) = 0;
 
   /// Is the messaging object ready for processing BiDirectional
   /// request/response?
diff --git a/TAO/tao/Transport.cpp b/TAO/tao/Transport.cpp
index 19f8c05adf8..ba4c262a11f 100644
--- a/TAO/tao/Transport.cpp
+++ b/TAO/tao/Transport.cpp
@@ -1234,7 +1234,7 @@ TAO_Transport::handle_input (TAO_Resume_Handle &rh,
   if (TAO_debug_level > 2)
     {
       ACE_DEBUG ((LM_DEBUG,
-                  "TAO (%P|%t) - Transport[%d]::handle_input_i, "
+                  "TAO (%P|%t) - Transport[%d]::handle_input, "
                   "read %d bytes\n",
                   this->id (), n));
     }
diff --git a/TAO/tao/Transport.h b/TAO/tao/Transport.h
index 9dd351b3f9f..b15c8bf9340 100644
--- a/TAO/tao/Transport.h
+++ b/TAO/tao/Transport.h
@@ -128,7 +128,7 @@ struct iovec;
  * process the incoming GIOP message as quickly and efficiently as
  * possible. There are other forces that needs to be given due
  * consideration. They are
- *  - Multiple threads should  be able to tarverse along the same data
+ *  - Multiple threads should be able to traverse along the same data
  *    path but should not be able to read from the same handle at the
  *    same time ie. the handle should not be shared between threads at
  *    any instant.
@@ -262,8 +262,10 @@ public:
   /// Set the bidirectional flag
   void bidirectional_flag (int flag);
 
-  /// Set/Get the Cache Map entry
+  /// Set the Cache Map entry
   void cache_map_entry (TAO_Transport_Cache_Manager::HASH_MAP_ENTRY *entry);
+
+  /// Get the Cache Map entry
   TAO_Transport_Cache_Manager::HASH_MAP_ENTRY *cache_map_entry (void);
 
   /// Set and Get the identifier for this transport instance.
@@ -290,7 +292,7 @@ public:
   /**
    * Called by the cache when the cache is closing.
    *
-   * @param handlers the TAO_Connection_Handler_Set into which the
+   * @param handlers The TAO_Connection_Handler_Set into which the
    *        transport should place its handler
    */
   void provide_handler (TAO_Connection_Handler_Set &handlers);