diff options
author | Johnny Willemsen <jwillemsen@remedy.nl> | 2010-02-04 09:09:22 +0000 |
---|---|---|
committer | Johnny Willemsen <jwillemsen@remedy.nl> | 2010-02-04 09:09:22 +0000 |
commit | eace4b4d9252f7e141bc722b80815092cf833ca8 (patch) | |
tree | 0efd7fe66338f2fc7ab20d4d8869ad3619113800 /TAO/TAO_IDL/be_include/be_decl.h | |
parent | d0344f87cb35b11542d386f1a38e889c79c499a9 (diff) | |
download | ATCD-eace4b4d9252f7e141bc722b80815092cf833ca8.tar.gz |
Thu Feb 4 09:01:43 UTC 2010 Johnny Willemsen <jwillemsen@remedy.nl>
* TAO_IDL/*.h:
Converted to doxygen style of documentation
Diffstat (limited to 'TAO/TAO_IDL/be_include/be_decl.h')
-rw-r--r-- | TAO/TAO_IDL/be_include/be_decl.h | 68 |
1 files changed, 33 insertions, 35 deletions
diff --git a/TAO/TAO_IDL/be_include/be_decl.h b/TAO/TAO_IDL/be_include/be_decl.h index ddf1063d235..98a1beb1f4d 100644 --- a/TAO/TAO_IDL/be_include/be_decl.h +++ b/TAO/TAO_IDL/be_include/be_decl.h @@ -1,23 +1,19 @@ /* -*- c++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO IDL -// -// = FILENAME -// be_decl.h -// -// = DESCRIPTION -// Extension of the AST_Decl class. -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems, Inc. -// and -// Aniruddha Gokhale -// -// ============================================================================ + +//============================================================================= +/** + * @file be_decl.h + * + * $Id$ + * + * Extension of the AST_Decl class. + * + * + * @author Copyright 1994-1995 by Sun Microsystems + * @author Inc. and Aniruddha Gokhale + */ +//============================================================================= + #ifndef TAO_BE_DECL_H #define TAO_BE_DECL_H @@ -28,51 +24,53 @@ class be_scope; class be_visitor; class be_type; +/** + * @class be_decl + * + * @brief be_decl + * + * The back end extension of the AST_Decl class. Provides an abstract + * interface. + */ class be_decl : public virtual AST_Decl { - // = TITLE - // be_decl - // = DESCRIPTION - // The back end extension of the AST_Decl class. Provides an abstract - // interface. - // public: + /// Default constructor. be_decl (void); - // Default constructor. + /// Constructor that sets the node type. be_decl (AST_Decl::NodeType type, UTL_ScopedName *n); - // Constructor that sets the node type. + /// Destructor. ~be_decl (void); - // Destructor. // Methods used by the interface type strategy. + /// Both the arguments should be non-null!!!. Applies prefix and + /// suffix to the local name and makes a flat name. void compute_full_name (const char *prefix, const char *suffix, char *&name); - // Both the arguments should be non-null!!!. Applies prefix and - // suffix to the local name and makes a flat name. + /// Both the arguments should be non-null!!!. Applies prefix and + /// suffix to the local name and makes a flat name. void compute_flat_name (const char *prefix, const char *suffix, char *& name); - // Both the arguments should be non-null!!!. Applies prefix and - // suffix to the local name and makes a flat name. // End of Methods use by the interface type strategy. + /// Return the scope created by this node (if one exists). virtual be_scope *scope (void); - // Return the scope created by this node (if one exists). // Visiting virtual int accept (be_visitor *visitor); + /// Cleanup function. virtual void destroy (void); - // Cleanup function. + /// Temporarily set this node's is_local_ flag. void set_local (bool val); - // Temporarily set this node's is_local_ flag. // Boolean methods to test if code was already generated. bool cli_hdr_gen (void); |