diff options
| author | coryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795> | 2000-11-01 22:17:39 +0000 |
|---|---|---|
| committer | coryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795> | 2000-11-01 22:17:39 +0000 |
| commit | 4cdff4b3e2dbc73b00e671ef638d71d6d854e0ac (patch) | |
| tree | 97236ece363cff48fd287c780db4290da39b02cb /ace/Auto_IncDec_T.h | |
| parent | 7b6368ec78831d127f38eb7b630c21f98faf6a83 (diff) | |
| download | ATCD-4cdff4b3e2dbc73b00e671ef638d71d6d854e0ac.tar.gz | |
ChangeLogTag:Wed Nov 1 14:11:48 2000 Carlos O'Ryan <coryan@uci.edu>
Diffstat (limited to 'ace/Auto_IncDec_T.h')
| -rw-r--r-- | ace/Auto_IncDec_T.h | 53 |
1 files changed, 26 insertions, 27 deletions
diff --git a/ace/Auto_IncDec_T.h b/ace/Auto_IncDec_T.h index 39a8818ae81..f2a10e498f8 100644 --- a/ace/Auto_IncDec_T.h +++ b/ace/Auto_IncDec_T.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ -//============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// Auto_IncDec_T.h -// -// = AUTHOR -// Edan Ayal <EdanA@cti2.com> -// -//============================================================================ +//============================================================================= +/** + * @file Auto_IncDec_T.h + * + * $Id$ + * + * @author Edan Ayal <EdanA@cti2.com> + */ +//============================================================================= + #ifndef ACE_AUTO_INCDEC_T_H #define ACE_AUTO_INCDEC_T_H @@ -24,33 +21,35 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class ACE_Auto_IncDec + * + * @brief This class automatically increments and decrements a + * parameterized counter. + * + * This data structure is meant to be used within a method, + * function, or scope. The actual parameter given for the + * <ACE_SAFELY_INCREMENTABLE_DECREMENTABLE> template parameter + * must provide at least opertaors ++ and --. + */ template <class ACE_SAFELY_INCREMENTABLE_DECREMENTABLE> class ACE_Auto_IncDec { - // = TITLE - // This class automatically increments and decrements a - // parameterized counter. - // - // = DESCRIPTION - // This data structure is meant to be used within a method, - // function, or scope. The actual parameter given for the - // <ACE_SAFELY_INCREMENTABLE_DECREMENTABLE> template parameter - // must provide at least opertaors ++ and --. public: // = Initialization and termination methods. + /// Implicitly increment the counter. ACE_Auto_IncDec (ACE_SAFELY_INCREMENTABLE_DECREMENTABLE &counter); - // Implicitly increment the counter. + /// Implicitly decrement the counter. ~ACE_Auto_IncDec (void); - // Implicitly decrement the counter. + /// Dump the state of an object. void dump (void) const; - // Dump the state of an object. protected: + /// Reference to the <ACE_SAFELY_INCREMENTABLE_DECREMENTABLE> counter + /// we're incrementing/decrementing. ACE_SAFELY_INCREMENTABLE_DECREMENTABLE &counter_; - // Reference to the <ACE_SAFELY_INCREMENTABLE_DECREMENTABLE> counter - // we're incrementing/decrementing. private: // = Prevent assignment and initialization. |