summaryrefslogtreecommitdiff
path: root/TAO/tao/IOR_Parser.h
diff options
context:
space:
mode:
authorcoryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>2000-12-15 20:06:51 +0000
committercoryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>2000-12-15 20:06:51 +0000
commit2f33b02d0037bc8ee6788c2840c7822922c0c952 (patch)
treedd9680e93d92ed55dcab63954c75283209681cb8 /TAO/tao/IOR_Parser.h
parentbb98ac0816b9558d489efbdf87833dbbbbb75b80 (diff)
downloadATCD-2f33b02d0037bc8ee6788c2840c7822922c0c952.tar.gz
ChangeLogTag:Fri Dec 15 11:36:08 2000 Carlos O'Ryan <coryan@uci.edu>
Diffstat (limited to 'TAO/tao/IOR_Parser.h')
-rw-r--r--TAO/tao/IOR_Parser.h58
1 files changed, 29 insertions, 29 deletions
diff --git a/TAO/tao/IOR_Parser.h b/TAO/tao/IOR_Parser.h
index 5d182a0ce63..a9951aa210a 100644
--- a/TAO/tao/IOR_Parser.h
+++ b/TAO/tao/IOR_Parser.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO
-//
-// = FILENAME
-// IOR_Parser.h
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file IOR_Parser.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef TAO_IOR_PARSER_H
#define TAO_IOR_PARSER_H
@@ -26,32 +23,35 @@
#include "ace/Service_Object.h"
+/**
+ * @class TAO_IOR_Parser
+ *
+ * @brief Defines the interface for the pluggable IOR parser components
+ *
+ * The ORB is able to dynamically load the list of IOR formats it
+ * understands. That allow us to integrate formats such as
+ * corbaname:, http: or ftp: only when required.
+ * This class provides a uniform interface for all the IOR parsers
+ */
class TAO_Export TAO_IOR_Parser : public ACE_Service_Object
{
- // = TITLE
- // Defines the interface for the pluggable IOR parser components
- //
- // = DESCRIPTION
- // The ORB is able to dynamically load the list of IOR formats it
- // understands. That allow us to integrate formats such as
- // corbaname:, http: or ftp: only when required.
- // This class provides a uniform interface for all the IOR parsers
- //
public:
+ /// The destructor
virtual ~TAO_IOR_Parser (void);
- // The destructor
+ /// Return 1 if <ior_string> starts with a prefix known to this IOR
+ /// parser
virtual int match_prefix (const char *ior_string) const = 0;
- // Return 1 if <ior_string> starts with a prefix known to this IOR
- // parser
+ /**
+ * Parse the <ior> argument and return an object reference.
+ * The call may raise the standard system exceptions (NO_MEMORY,
+ * INV_OBJREF, etc.)
+ */
virtual CORBA::Object_ptr parse_string (const char *ior,
CORBA::ORB_ptr orb,
CORBA::Environment &)
ACE_THROW_SPEC ((CORBA::SystemException)) = 0;
- // Parse the <ior> argument and return an object reference.
- // The call may raise the standard system exceptions (NO_MEMORY,
- // INV_OBJREF, etc.)
};
#if defined (__ACE_INLINE__)