Browse Source

[1773] comment updates due to interface changes as part of fix.

JINMEI Tatuya 13 years ago
parent
commit
cc73f7e20f
1 changed files with 4 additions and 2 deletions
  1. 4 2
      src/lib/bench/benchmark.h

+ 4 - 2
src/lib/bench/benchmark.h

@@ -241,14 +241,16 @@ public:
     ///
     /// This method will be called from \c run() before starting the benchmark.
     /// By default it's empty, but can be customized via template
-    /// specialization.
+    /// specialization.  When specialized, a reference to the target object
+    /// given to the constructor will be passed to the implementation.
     void setUp(T&) {}
 
     /// \brief Hook to be called after benchmark.
     ///
     /// This method will be called from \c run() when the benchmark completes.
     /// By default it's empty, but can be customized via template
-    /// specialization.
+    /// specialization.  When specialized, a reference to the target object
+    /// given to the constructor will be passed to the implementation.
     void tearDown(T&) {}
 
     /// \brief Perform benchmark.