summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorirfan <irfan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>1998-12-07 02:55:23 +0000
committerirfan <irfan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>1998-12-07 02:55:23 +0000
commite34f6767648986393685180920e736617972d4d4 (patch)
tree35d0287c42ff31ea2d2ab0c4db15e593c0ad772a
parent8792e3fe48977ad7c3fc8523e7bf139600a80bde (diff)
downloadATCD-e34f6767648986393685180920e736617972d4d4.tar.gz
*** empty log message ***
-rw-r--r--ace/Timeprobe.h40
1 files changed, 40 insertions, 0 deletions
diff --git a/ace/Timeprobe.h b/ace/Timeprobe.h
index 88417c4a264..b5728a32ece 100644
--- a/ace/Timeprobe.h
+++ b/ace/Timeprobe.h
@@ -1,6 +1,46 @@
/* -*- C++ -*- */
// $Id$
+// ============================================================================
+//
+// = LIBRARY
+// ace
+//
+// = FILENAME
+// Timeprobe.h
+//
+// = AUTHOR
+// Irfan Pyarali
+//
+// = ADDITIONAL COMMENTS
+//
+// If users want to use time probes, the ACE_COMPILE_TIMEPROBES
+// flag must be defined when compiling ACE. This can be achieved
+// by doing one of the following:
+//
+// . Use make probe = 1, if you are using the make utility.
+//
+// . Define ACE_COMPILE_TIMEPROBES in config.h
+//
+// . Define ACE_COMPILE_TIMEPROBES in the VC project file.
+//
+// . Other regular methods will also work.
+//
+// It is not necessary to define ACE_COMPILE_TIMEPROBES when using
+// time probes, you simply need ACE_ENABLE_TIMEPROBES. You can use
+// the ACE_TIMEPROBE_* macros to program the time probes, and use
+// the ACE_ENABLE_TIMEPROBE to enable the time probes. If you
+// define ACE_ENABLE_TIMEPROBE in your code, but forget to compile
+// ACE with ACE_COMPILE_TIMEPROBES, you will end up with linker
+// errors.
+//
+// Remember that ACE_COMPILE_TIMEPROBES means that the ACE library
+// will contain code for time probes. This is only useful when
+// compiling ACE. ACE_ENABLE_TIMEPROBES means that the
+// ACE_TIMEPROBE_* macros should spring to life.
+//
+// ============================================================================
+
#ifndef ACE_TIMEPROBE_H
#define ACE_TIMEPROBE_H