Add a load of explicit keywords.
[dcpomatic.git] / src / lib / timer.h
index 8ec392aa63a212dc708356d819f58d1676393e2e..9ea95c7203850f329b67178c3a3e5c9f5f73c822 100644 (file)
@@ -1,20 +1,20 @@
 /*
     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
     Copyright (C) 2000-2007 Paul Davis
+    This file is part of DCP-o-matic.
 
-    This program is free software; you can redistribute it and/or modify
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     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., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 #ifndef DCPOMATIC_TIMER_H
 #define DCPOMATIC_TIMER_H
 
+#include <sys/time.h>
 #include <string>
 #include <map>
-#include <sys/time.h>
 
-/** @class PeriodDCPTimer
+/** @class PeriodTimer
  *  @brief A class to allow timing of a period within the caller.
  *
  *  On destruction, it will output the time since its construction.
  */
-class PeriodDCPTimer
+class PeriodTimer
 {
 public:
-       PeriodDCPTimer (std::string n);
-       ~PeriodDCPTimer ();
-       
+       explicit PeriodTimer (std::string n);
+       ~PeriodTimer ();
+
 private:
 
        /** name to use when giving output */
@@ -48,19 +48,19 @@ private:
        struct timeval _start;
 };
 
-/** @class StateDCPTimer
+/** @class StateTimer
  *  @brief A class to allow measurement of the amount of time a program
  *  spends in one of a set of states.
  *
  *  Once constructed, the caller can call set_state() whenever
- *  its state changes. When StateDCPTimer is destroyed, it will
+ *  its state changes. When StateTimer is destroyed, it will
  *  output (to cout) a summary of the time spent in each state.
  */
-class StateDCPTimer
+class StateTimer
 {
 public:
-       StateDCPTimer (std::string n, std::string s);
-       ~StateDCPTimer ();
+       StateTimer (std::string n, std::string s);
+       ~StateTimer ();
 
        void set_state (std::string s);