diff options
Diffstat (limited to 'ace/Dump_T.h')
| -rw-r--r-- | ace/Dump_T.h | 53 |
1 files changed, 26 insertions, 27 deletions
diff --git a/ace/Dump_T.h b/ace/Dump_T.h index 88b2765f721..f9856353797 100644 --- a/ace/Dump_T.h +++ b/ace/Dump_T.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// Dump.h -// -// = AUTHOR -// Doug Schmidt -// -// ============================================================================ +//============================================================================= +/** + * @file Dump.h + * + * $Id$ + * + * @author Doug Schmidt + */ +//============================================================================= + #ifndef ACE_DUMP_T_H #define ACE_DUMP_T_H @@ -24,34 +21,36 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class ACE_Dumpable_Adapter + * + * @brief This class inherits the interface of the abstract ACE_Dumpable + * class and is instantiated with the implementation of the + * concrete component class <class Concrete>. + * + * This design is similar to the Adapter and Decorator patterns + * from the ``Gang of Four'' book. Note that <class Concrete> + * need not inherit from a common class since ACE_Dumpable + * provides the uniform virtual interface! + */ template <class Concrete> class ACE_Dumpable_Adapter : public ACE_Dumpable { - // = TITLE - // This class inherits the interface of the abstract ACE_Dumpable - // class and is instantiated with the implementation of the - // concrete component class <class Concrete>. - // - // = DESCRIPTION - // This design is similar to the Adapter and Decorator patterns - // from the ``Gang of Four'' book. Note that <class Concrete> - // need not inherit from a common class since ACE_Dumpable - // provides the uniform virtual interface! public: // = Initialization and termination methods. ACE_Dumpable_Adapter (const Concrete *t); ~ACE_Dumpable_Adapter (void); + /// Concrete dump method (simply delegates to the <dump> method of + /// <class Concrete>). virtual void dump (void) const; - // Concrete dump method (simply delegates to the <dump> method of - // <class Concrete>). + /// Delegate to methods in the Concrete class. Concrete *operator->() const; - // Delegate to methods in the Concrete class. private: + /// Pointer to <this> of <class Concrete>. const Concrete *this_; - // Pointer to <this> of <class Concrete>. }; // Some useful macros for conditionally compiling this feature... |