diff options
Diffstat (limited to 'ace/Trace.h')
| -rw-r--r-- | ace/Trace.h | 69 |
1 files changed, 34 insertions, 35 deletions
diff --git a/ace/Trace.h b/ace/Trace.h index b75fed44148..fe46767ff53 100644 --- a/ace/Trace.h +++ b/ace/Trace.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// Trace.h -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Trace.h + * + * $Id$ + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_TRACE_H @@ -21,60 +18,62 @@ #include "ace/OS.h" +/** + * @class ACE_Trace + * + * @brief A C++ trace facility that keeps track of which methods are + * entered and exited. + * + * This class uses C++ constructors and destructors to automate + * the ACE_Trace nesting. In addition, thread-specific storage + * is used to enable multiple threads to work correctly. + */ class ACE_Export ACE_Trace { - // = TITLE - // A C++ trace facility that keeps track of which methods are - // entered and exited. - // - // = DESCRIPTION - // This class uses C++ constructors and destructors to automate - // the ACE_Trace nesting. In addition, thread-specific storage - // is used to enable multiple threads to work correctly. public: // = Initialization and termination methods. + /// Perform the first part of the trace, which prints out the string + /// N, the LINE, and the ACE_FILE as the function is entered. ACE_Trace (const ACE_TCHAR *n, int line = 0, const ACE_TCHAR *file = ACE_LIB_TEXT ("")); - // Perform the first part of the trace, which prints out the string - // N, the LINE, and the ACE_FILE as the function is entered. + /// Perform the second part of the trace, which prints out the NAME + /// as the function is exited. ~ACE_Trace (void); - // Perform the second part of the trace, which prints out the NAME - // as the function is exited. // = Control the tracing level. + /// Determine if tracing is enabled (return == 1) or not (== 0) static int is_tracing(void); - // Determine if tracing is enabled (return == 1) or not (== 0) + /// Enable the tracing facility. static void start_tracing (void); - // Enable the tracing facility. + /// Disable the tracing facility. static void stop_tracing (void); - // Disable the tracing facility. + /// Change the nesting indentation level. static void set_nesting_indent (int indent); - // Change the nesting indentation level. + /// Dump the state of an object. void dump (void) const; - // Dump the state of an object. private: // Keeps track of how deeply the call stack is nested (this is // maintained in thread-specific storage to ensure correctness in // multiple threads of control. + /// Name of the method we are in. const ACE_TCHAR *name_; - // Name of the method we are in. + /// Keeps track of how far to indent per trace call. static int nesting_indent_; - // Keeps track of how far to indent per trace call. + /// Is tracing enabled? static int enable_tracing_; - // Is tracing enabled? - // Default values. + /// Default values. enum { DEFAULT_INDENT = 3, |