diff options
Diffstat (limited to 'ace/CORBA_Ref.h')
| -rw-r--r-- | ace/CORBA_Ref.h | 74 |
1 files changed, 37 insertions, 37 deletions
diff --git a/ace/CORBA_Ref.h b/ace/CORBA_Ref.h index e469dabb718..9010c8c82fd 100644 --- a/ace/CORBA_Ref.h +++ b/ace/CORBA_Ref.h @@ -1,22 +1,20 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// CORBA_Ref.h -// -// = AUTHOR -// Irfan Pyarali (irfan@wuerl.wustl.edu). -// Tim Harrison (harrison@cs.wustl.edu) -// -// = DESCRIPTION -// A wrapper for helping with Orbix object references. -// -// ============================================================================ + +//============================================================================= +/** + * @file CORBA_Ref.h + * + * $Id$ + * + * @author Irfan Pyarali (irfan@wuerl.wustl.edu) + * @author Tim Harrison (harrison@cs.wustl.edu) + * + * A wrapper for helping with Orbix object references. + * + * + */ +//============================================================================= + #ifndef ACE_CORBA_REF_H #define ACE_CORBA_REF_H @@ -28,44 +26,46 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class ACE_CORBA_Ref + * + * @brief A wrapper for helping with Orbix object references. + * + * <ACE_CORBA_Ref> is parameterized by the type of orbix object + * reference to be used. The construtor, operator=, and the + * destructor of <ACE_CORBA_Ref> perform implicit duplicates and + * releases in order to help make the use of Orbix object + * references transparent. + */ template <class CORBA_REF> class ACE_CORBA_Ref { - // = TITLE - // A wrapper for helping with Orbix object references. - // - // = DESCRIPTION - // <ACE_CORBA_Ref> is parameterized by the type of orbix object - // reference to be used. The construtor, operator=, and the - // destructor of <ACE_CORBA_Ref> perform implicit duplicates and - // releases in order to help make the use of Orbix object - // references transparent. public: + /// Null construction. ACE_CORBA_Ref (void); - // Null construction. + /// Contruction with an orbix ref. + /// performs a <CORBA_REF::_duplicate>. ACE_CORBA_Ref (CORBA_REF *ref); - // Contruction with an orbix ref. - // performs a <CORBA_REF::_duplicate>. + /// Assignment performs a <CORBA_REF::_duplicate>. CORBA_REF *operator= (CORBA_REF *ref); - // Assignment performs a <CORBA_REF::_duplicate>. + /// Type operator operator CORBA_REF *(void) const; - // Type operator + /// Smart pointer to forward all CORBA_REF calls to the underlying + /// Orbix reference. CORBA_REF *operator-> (void) const; - // Smart pointer to forward all CORBA_REF calls to the underlying - // Orbix reference. + /// Pointer comparison. int operator== (CORBA_REF *) const; - // Pointer comparison. + /// Pointer comparison. int operator!= (CORBA_REF *) const; - // Pointer comparison. + /// Destruction: calls <CORBA_REF::_release>. ~ACE_CORBA_Ref (void); - // Destruction: calls <CORBA_REF::_release>. private: CORBA_REF *ref_; |