summaryrefslogtreecommitdiff
path: root/TAO/TAO_IDL/be_include
diff options
context:
space:
mode:
authorJohnny Willemsen <jwillemsen@remedy.nl>2011-03-29 12:25:33 +0000
committerJohnny Willemsen <jwillemsen@remedy.nl>2011-03-29 12:25:33 +0000
commit089d5dc98c5b8fa0af29ee997e6fd01c2d5dd5a0 (patch)
treed5be49e225ae3928d7605470e0f662e6dd9eab1a /TAO/TAO_IDL/be_include
parent754ae6d6a8f14b0a8ad8fb4cc0e5ddf0d57e35b9 (diff)
downloadATCD-089d5dc98c5b8fa0af29ee997e6fd01c2d5dd5a0.tar.gz
Tue Mar 29 12:24:55 UTC 2011 Johnny Willemsen <jwillemsen@remedy.nl>
* TAO_IDL/be_include/be_component.h: * TAO_IDL/be_include/be_eventtype.h: * TAO_IDL/be_include/be_extended_port.h: * TAO_IDL/be_include/be_helper.h: * TAO_IDL/be_include/be_identifier_helper.h: * TAO_IDL/be_include/be_interface.h: * TAO_IDL/be_include/be_mirror_port.h: * TAO_IDL/be_include/be_porttype.h: * TAO_IDL/be_include/be_root.h: * TAO_IDL/be_include/be_template_module.h: * TAO_IDL/be_include/be_valuetype.h: * TAO_IDL/be_include/be_visitor_attribute/ccm_init.h: * TAO_IDL/be_include/be_visitor_attribute/set_from_extracted.h: * TAO_IDL/be_include/be_visitor_component/component_ami_rh_ex_base.h: * TAO_IDL/be_include/be_visitor_operation/argument_marshal.h: * TAO_IDL/include/ast_visitor_tmpl_module_ref.h: * TAO_IDL/include/fe_private.h: Doxygen changes
Diffstat (limited to 'TAO/TAO_IDL/be_include')
-rw-r--r--TAO/TAO_IDL/be_include/be_component.h8
-rw-r--r--TAO/TAO_IDL/be_include/be_eventtype.h11
-rw-r--r--TAO/TAO_IDL/be_include/be_extended_port.h10
-rw-r--r--TAO/TAO_IDL/be_include/be_helper.h26
-rw-r--r--TAO/TAO_IDL/be_include/be_identifier_helper.h17
-rw-r--r--TAO/TAO_IDL/be_include/be_interface.h8
-rw-r--r--TAO/TAO_IDL/be_include/be_mirror_port.h10
-rw-r--r--TAO/TAO_IDL/be_include/be_porttype.h10
-rw-r--r--TAO/TAO_IDL/be_include/be_root.h8
-rw-r--r--TAO/TAO_IDL/be_include/be_template_module.h8
-rw-r--r--TAO/TAO_IDL/be_include/be_valuetype.h13
-rw-r--r--TAO/TAO_IDL/be_include/be_visitor_attribute/ccm_init.h12
-rw-r--r--TAO/TAO_IDL/be_include/be_visitor_attribute/set_from_extracted.h13
-rw-r--r--TAO/TAO_IDL/be_include/be_visitor_component/component_ami_rh_ex_base.h4
-rw-r--r--TAO/TAO_IDL/be_include/be_visitor_operation/argument_marshal.h12
15 files changed, 61 insertions, 109 deletions
diff --git a/TAO/TAO_IDL/be_include/be_component.h b/TAO/TAO_IDL/be_include/be_component.h
index d98e3d47d70..0122cdb0f15 100644
--- a/TAO/TAO_IDL/be_include/be_component.h
+++ b/TAO/TAO_IDL/be_include/be_component.h
@@ -22,14 +22,12 @@
class AST_PortType;
+/**
+ * The back end extension of the AST_Component class
+ */
class be_component : public virtual AST_Component,
public virtual be_interface
{
- // = TITLE
- // The back end extension of the AST_Component class
- //
- // = DESCRIPTION
- //
public:
be_component (UTL_ScopedName *n,
AST_Component *base_component,
diff --git a/TAO/TAO_IDL/be_include/be_eventtype.h b/TAO/TAO_IDL/be_include/be_eventtype.h
index 1a4a4582c6d..95d8573f087 100644
--- a/TAO/TAO_IDL/be_include/be_eventtype.h
+++ b/TAO/TAO_IDL/be_include/be_eventtype.h
@@ -19,15 +19,14 @@
#include "be_valuetype.h"
#include "ast_eventtype.h"
+/**
+ * Backend-class for eventtypes
+ *
+ * Extends be_valuetype.
+ */
class be_eventtype : public virtual be_valuetype,
public virtual AST_EventType
{
- // = TITLE
- // Backend-class for eventtypes
- //
- // = DESCRIPTION
- // Extends be_valuetype.
- //
public:
be_eventtype (UTL_ScopedName *n,
AST_Type **inherits,
diff --git a/TAO/TAO_IDL/be_include/be_extended_port.h b/TAO/TAO_IDL/be_include/be_extended_port.h
index de339dd9e99..e69ce8cb1f5 100644
--- a/TAO/TAO_IDL/be_include/be_extended_port.h
+++ b/TAO/TAO_IDL/be_include/be_extended_port.h
@@ -24,16 +24,12 @@
class be_visitor;
+/**
+ * Extension of class AST_Extended_Port for C++ code generation.
+ */
class be_extended_port : public virtual AST_Extended_Port,
public virtual be_field
{
- //
- // = TITLE
- // be_extended_port
- //
- // = DESCRIPTION
- // Extension of class AST_Extended_Port for C++ code generation.
- //
public:
be_extended_port (
UTL_ScopedName *n,
diff --git a/TAO/TAO_IDL/be_include/be_helper.h b/TAO/TAO_IDL/be_include/be_helper.h
index c9da90e7d32..fa1938ef12a 100644
--- a/TAO/TAO_IDL/be_include/be_helper.h
+++ b/TAO/TAO_IDL/be_include/be_helper.h
@@ -36,29 +36,27 @@ struct TAO_NL_2
TAO_NL_2 (void);
};
+/**
+ * Operates like a manipulator, increasing the indentation level.
+ *
+ * Increase the indentation level, if the "do_now" parameter is
+ * not zero then the <indent> method is called on the stream.
+ */
struct TAO_INDENT
{
- // = TITLE
- // Operates like a manipulator, increasing the indentation level.
- //
- // = DESCRIPTION
- // Increase the indentation level, if the "do_now" parameter is
- // not zero then the <indent> method is called on the stream.
- //
TAO_INDENT (int do_now = 0);
const int do_now_;
};
+/**
+ * Operates like a manipulator, decreasing the indentation level.
+ *
+ * Decrease the indentation level, if the "do_now" parameter is
+ * not zero then the <indent> method is called on the stream.
+ */
struct TAO_UNINDENT
{
- // = TITLE
- // Operates like a manipulator, decreasing the indentation level.
- //
- // = DESCRIPTION
- // Decrease the indentation level, if the "do_now" parameter is
- // not zero then the <indent> method is called on the stream.
- //
TAO_UNINDENT (int do_now = 0);
const int do_now_;
diff --git a/TAO/TAO_IDL/be_include/be_identifier_helper.h b/TAO/TAO_IDL/be_include/be_identifier_helper.h
index a8737a086d2..5ef99d01291 100644
--- a/TAO/TAO_IDL/be_include/be_identifier_helper.h
+++ b/TAO/TAO_IDL/be_include/be_identifier_helper.h
@@ -30,19 +30,14 @@ class Identifier;
class be_type;
class be_visitor;
+/**
+ * 1) keeps escape (leading underscore character in generated identifier in IDL
+ * 2) removes the '_' escape character when the identifier is
+ * part of another identifier such as in provides_XXX
+ * 3) removes any '_cxx_' in generated IDL
+ */
struct TAO_IDL_BE_Export IdentifierHelper
{
- //
- // = TITLE
- // IdentifierHelper.
- //
- // = DESCRIPTION
- // 1) keeps escape (leading underscore character in generated
- // identifier in IDL
- // 2) removes the '_' escape character when the identifier is
- // part of another identifier such as in provides_XXX
- // 3) removes any '_cxx_' in generated IDL
-
static const char *
type_name (be_type *t, be_visitor *visitor);
diff --git a/TAO/TAO_IDL/be_include/be_interface.h b/TAO/TAO_IDL/be_include/be_interface.h
index f834454ce84..2591251a3b8 100644
--- a/TAO/TAO_IDL/be_include/be_interface.h
+++ b/TAO/TAO_IDL/be_include/be_interface.h
@@ -31,15 +31,13 @@ class be_visitor;
class UTL_ExceptList;
+/**
+ * The back end extension of the AST_Interface class
+ */
class be_interface : public virtual AST_Interface,
public virtual be_scope,
public virtual be_type
{
- // = TITLE
- // The back end extension of the AST_Interface class
- //
- // = DESCRIPTION
- //
public:
// Used to pass functions to the template method.
typedef int (*tao_code_emitter) (be_interface *,
diff --git a/TAO/TAO_IDL/be_include/be_mirror_port.h b/TAO/TAO_IDL/be_include/be_mirror_port.h
index 9616ca83064..418517cb177 100644
--- a/TAO/TAO_IDL/be_include/be_mirror_port.h
+++ b/TAO/TAO_IDL/be_include/be_mirror_port.h
@@ -23,16 +23,12 @@
class be_visitor;
+/**
+ * Extension of class AST_Mirror_Port for C++ code generation.
+ */
class be_mirror_port : public virtual AST_Mirror_Port,
public virtual be_extended_port
{
- //
- // = TITLE
- // be_mirror_port
- //
- // = DESCRIPTION
- // Extension of class AST_Mirror_Port for C++ code generation.
- //
public:
be_mirror_port (
UTL_ScopedName *n,
diff --git a/TAO/TAO_IDL/be_include/be_porttype.h b/TAO/TAO_IDL/be_include/be_porttype.h
index 1ddf8f1dbd9..a664985f2ca 100644
--- a/TAO/TAO_IDL/be_include/be_porttype.h
+++ b/TAO/TAO_IDL/be_include/be_porttype.h
@@ -24,17 +24,13 @@
class be_visitor;
+/**
+ * Extension of class AST_PortType for C++ code generation.
+ */
class be_porttype : public virtual AST_PortType,
public virtual be_scope,
public virtual be_type
{
- //
- // = TITLE
- // be_porttype
- //
- // = DESCRIPTION
- // Extension of class AST_PortType for C++ code generation.
- //
public:
be_porttype (UTL_ScopedName *n);
diff --git a/TAO/TAO_IDL/be_include/be_root.h b/TAO/TAO_IDL/be_include/be_root.h
index b077d4388b5..a233ed0a3c4 100644
--- a/TAO/TAO_IDL/be_include/be_root.h
+++ b/TAO/TAO_IDL/be_include/be_root.h
@@ -22,14 +22,12 @@
class be_visitor;
+/**
+ * The back end extension of the AST_Root class
+ */
class be_root : public virtual AST_Root,
public virtual be_module
{
- // = TITLE
- // The back end extension of the AST_Root class
- //
- // = DESCRIPTION
- //
public:
be_root (UTL_ScopedName *n);
diff --git a/TAO/TAO_IDL/be_include/be_template_module.h b/TAO/TAO_IDL/be_include/be_template_module.h
index 787a04ba555..c2f66101de6 100644
--- a/TAO/TAO_IDL/be_include/be_template_module.h
+++ b/TAO/TAO_IDL/be_include/be_template_module.h
@@ -23,15 +23,13 @@
#include "ast_template_module.h"
+/**
+ * The back end extension of the AST_Template_Module class
+ */
class be_template_module : public virtual AST_Template_Module,
public virtual be_scope,
public virtual be_decl
{
- // = TITLE
- // The back end extension of the AST_Template_Module class
- //
- // = DESCRIPTION
- //
public:
be_template_module (
UTL_ScopedName *n,
diff --git a/TAO/TAO_IDL/be_include/be_valuetype.h b/TAO/TAO_IDL/be_include/be_valuetype.h
index 29362592118..b060aa3d62e 100644
--- a/TAO/TAO_IDL/be_include/be_valuetype.h
+++ b/TAO/TAO_IDL/be_include/be_valuetype.h
@@ -22,16 +22,15 @@
class TAO_OutStream;
+/**
+ * Backend-class for valuetypes
+ *
+ * Extends be_interface and overrides member functions for valuetype
+ * mapping.
+ */
class be_valuetype : public virtual be_interface,
public virtual AST_ValueType
{
- // = TITLE
- // Backend-class for valuetypes
- //
- // = DESCRIPTION
- // Extends be_interface and overrides member functions for valuetype
- // mapping.
- //
public:
be_valuetype (UTL_ScopedName *n,
AST_Type **inherits,
diff --git a/TAO/TAO_IDL/be_include/be_visitor_attribute/ccm_init.h b/TAO/TAO_IDL/be_include/be_visitor_attribute/ccm_init.h
index a7110b0b5e2..41cd0478800 100644
--- a/TAO/TAO_IDL/be_include/be_visitor_attribute/ccm_init.h
+++ b/TAO/TAO_IDL/be_include/be_visitor_attribute/ccm_init.h
@@ -16,18 +16,12 @@
#ifndef BE_VISITOR_ATTRIBUTE_CCM_INIT_H
#define BE_VISITOR_ATTRIBUTE_CCM_INIT_H
+/**
+ * Generates the body of a CIAO component or home's set_attributes() method.
+ */
class be_visitor_attribute_ccm_init
: public be_visitor_any_extracted_type_decl
{
- //
- // = TITLE
- // be_visitor_attribute_ccm_init
- //
- // = DESCRIPTION
- // Generates the body of a
- // CIAO component or home's set_attributes() method.
- //
- //
public:
be_visitor_attribute_ccm_init (be_visitor_context *ctx);
~be_visitor_attribute_ccm_init (void);
diff --git a/TAO/TAO_IDL/be_include/be_visitor_attribute/set_from_extracted.h b/TAO/TAO_IDL/be_include/be_visitor_attribute/set_from_extracted.h
index 3f07ddbc509..debda50c534 100644
--- a/TAO/TAO_IDL/be_include/be_visitor_attribute/set_from_extracted.h
+++ b/TAO/TAO_IDL/be_include/be_visitor_attribute/set_from_extracted.h
@@ -17,18 +17,13 @@
#ifndef BE_VISITOR_ATTRIBUTE_SET_FROM_EXTRACTED_H
#define BE_VISITOR_ATTRIBUTE_SET_FROM_EXTRACTED_H
+/**
+ * Contains overloaded methods that emit arg values to be
+ * passed to an attribute mutator
+ */
class be_visitor_attribute_set_from_extracted
: public be_visitor_any_extracted_type_decl
{
- //
- // = TITLE
- // be_visitor_attribute_set_from_extracted
- //
- // = DESCRIPTION
- // Contains overloaded methods that emit arg values to be
- // passed to an attribute mutator
- //
- //
public:
be_visitor_attribute_set_from_extracted (be_visitor_context *ctx);
virtual ~be_visitor_attribute_set_from_extracted (void);
diff --git a/TAO/TAO_IDL/be_include/be_visitor_component/component_ami_rh_ex_base.h b/TAO/TAO_IDL/be_include/be_visitor_component/component_ami_rh_ex_base.h
index d6d2ba2c7a3..6406e5deb4d 100644
--- a/TAO/TAO_IDL/be_include/be_visitor_component/component_ami_rh_ex_base.h
+++ b/TAO/TAO_IDL/be_include/be_visitor_component/component_ami_rh_ex_base.h
@@ -23,10 +23,6 @@ class be_visitor_context;
class be_visitor_component_ami_rh_ex_base
: public be_visitor_scope
{
- //
- // = TITLE
- // be_visitor_component_ami_rh_ex_base
- //
// = DESCRIPTION
// This is a base class visitor for the AMI4CCM reply
// handler implementation concrete visitors.
diff --git a/TAO/TAO_IDL/be_include/be_visitor_operation/argument_marshal.h b/TAO/TAO_IDL/be_include/be_visitor_operation/argument_marshal.h
index a42ef19565d..660be684a42 100644
--- a/TAO/TAO_IDL/be_include/be_visitor_operation/argument_marshal.h
+++ b/TAO/TAO_IDL/be_include/be_visitor_operation/argument_marshal.h
@@ -22,17 +22,13 @@
// generic operation visitor for docall, upcall, pre/post
// ************************************************************
+/**
+ * This is a visitor to generate a variable declaration of an operation
+ * return type
+ */
class be_visitor_operation_argument_marshal
: public be_visitor_operation_argument
{
- //
- // = TITLE
- // be_compiled_visitor_operation_argument_marshal
- //
- // = DESCRIPTION
- // This is a visitor to generate a variable declaration of an operation
- // return type
- //
public:
/// constructor
be_visitor_operation_argument_marshal (be_visitor_context *ctx);