Better error reporting for effects

[simgear.git] / simgear / misc / stopwatch.hxx

diff --git a/simgear/misc/stopwatch.hxx b/simgear/misc/stopwatch.hxx
index 4431d92e5d1036202e8b08ac8861157c012b2c23..34364387c21e54d91f2e046a8423367d1ab92716 100644 (file)
--- a/simgear/misc/stopwatch.hxx
+++ b/simgear/misc/stopwatch.hxx
@@ -1,12 +1,20 @@
-/***************************************************************************
- * stopwatch.hxx        Timer class, for use in benchmarking
- *
+/**
+ * \file stopwatch.hxx
+ * Timer class, for use in benchmarking
  * Based on blitz/Timer.h
  *
- * $Id$
- *
  * Copyright (C) 1997,1998 Todd Veldhuizen <tveldhui@seurat.uwaterloo.ca>
  *
+ * Suggestions:          blitz-suggest@cybervision.com
+ * Bugs:                 blitz-bugs@cybervision.com
+ *
+ * For more information, please see the Blitz++ Home Page:
+ *    http://seurat.uwaterloo.ca/blitz/
+ */
+
+/*
+ * $Id$
+ *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
  * License as published by the Free Software Foundation; either
@@ -17,16 +25,9 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Library General Public License for more details.
  *
- * You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA  02111-1307, USA.
- *
- * Suggestions:          blitz-suggest@cybervision.com
- * Bugs:                 blitz-bugs@cybervision.com
- *
- * For more information, please see the Blitz++ Home Page:
- *    http://seurat.uwaterloo.ca/blitz/
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  */
 
@@ -37,12 +38,12 @@
 #ifndef _STOPWATCH_HXX
 #define _STOPWATCH_HXX
 
-#ifndef __cplusplus                                                          
+#ifndef __cplusplus
 # error This library requires C++
-#endif                                   
+#endif
 
 #ifdef HAVE_CONFIG_H
-#  include <config.h>
+#  include <simgear_config.h>
 #endif
 
 #if defined(__linux__) && ! defined(HAVE_GETRUSAGE)
@@ -66,30 +67,34 @@
 #  include <time.h>
 #endif
 
+/**
+ * A high resolutions timing class
+ */
 class StopWatch {
 
 public:
-    StopWatch() 
-    { 
-//         state_ = uninitialized;
+    /** Constructor */
+    StopWatch() { 
+       // state_ = uninitialized;
     }
 
-    void start()
-    { 
-//         state_ = running;
+    /** Start counting time */
+    void start() { 
+       // state_ = running;
         t1_ = systemTime();
     }
 
-    void stop()
-    {
+    /** Stop counting time */
+    void stop() {
         t2_ = systemTime();
-//     BZPRECONDITION(state_ == running);
-//     state_ = stopped;
+       // BZPRECONDITION(state_ == running);
+       // state_ = stopped;
     }
 
+    /** @return the elapsed time between start and stop */
     double elapsedSeconds()
     {
-//         BZPRECONDITION(state_ == stopped);
+       // BZPRECONDITION(state_ == stopped);
         return t2_ - t1_;
     }