code cleanup: make header defines more consistent, JOYSENSOR header guard had a typo...
[blender-staging.git] / source / gameengine / Ketsji / KX_TimeCategoryLogger.h
index 0cc34b53736c2997720e3b427db4068fafafc1bd..d167d0addfe62eda9dd94a2399433606bce6efcd 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * $Id$
- *
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
@@ -15,7 +13,7 @@
  *
  * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  * All rights reserved.
  * ***** END GPL LICENSE BLOCK *****
  */
 
-#ifndef __KX_TIME_CATEGORY_LOGGER_H
-#define __KX_TIME_CATEGORY_LOGGER_H
+/** \file KX_TimeCategoryLogger.h
+ *  \ingroup ketsji
+ */
+
+#ifndef __KX_TIMECATEGORYLOGGER_H__
+#define __KX_TIMECATEGORYLOGGER_H__
 
-#ifdef WIN32
+#if defined(WIN32) && !defined(FREE_WINDOWS)
 #pragma warning (disable:4786) // suppress stl-MSVC debug info warning
 #endif
 
@@ -50,7 +52,7 @@ public:
 
        /**
         * Constructor.
-        * @param maxNumMesasurements Maximum number of measurements stored (> 1).
+        * \param maxNumMesasurements Maximum number of measurements stored (> 1).
         */
        KX_TimeCategoryLogger(unsigned int maxNumMeasurements = 10);
 
@@ -71,40 +73,40 @@ public:
 
        /**
         * Adds a category.
-        * @param category      The new category.
+        * \param category      The new category.
         */
        virtual void AddCategory(TimeCategory tc);
 
        /**
         * Starts logging in current measurement for the given category.
-        * @param tc                                    The category to log to.
-        * @param now                                   The current time.
-        * @param endOtherCategories    Whether to stop logging to other categories.
+        * \param tc                                    The category to log to.
+        * \param now                                   The current time.
+        * \param endOtherCategories    Whether to stop logging to other categories.
         */
        virtual void StartLog(TimeCategory tc, double now, bool endOtherCategories = true);
 
        /**
         * End logging in current measurement for the given category.
-        * @param tc    The category to log to.
-        * @param now   The current time.
+        * \param tc    The category to log to.
+        * \param now   The current time.
         */
        virtual void EndLog(TimeCategory tc, double now);
 
        /**
         * End logging in current measurement for all categories.
-        * @param now   The current time.
+        * \param now   The current time.
         */
        virtual void EndLog(double now);
 
        /**
         * Logs time in next measurement.
-        * @param now   The current time.
+        * \param now   The current time.
         */
        virtual void NextMeasurement(double now);
 
        /**
         * Returns average of all but the current measurement time.
-        * @return The average of all but the current measurement.
+        * \return The average of all but the current measurement.
         */
        virtual double GetAverage(TimeCategory tc);
 
@@ -125,7 +127,10 @@ protected:
        /** Maximum number of measurements. */
        unsigned int m_maxNumMeasurements;
 
-};
 
-#endif // __KX_TIME_CATEGORY_LOGGER_H
+#ifdef WITH_CXX_GUARDEDALLOC
+       MEM_CXX_CLASS_ALLOC_FUNCS("GE:KX_TimeCategoryLogger")
+#endif
+};
 
+#endif  /* __KX_TIMECATEGORYLOGGER_H__ */