code cleanup: make header defines more consistent, JOYSENSOR header guard had a typo...
[blender-staging.git] / source / gameengine / Ketsji / KX_TimeCategoryLogger.h
index b020683bfc663b875d0c3f78d7dd0cd08cc70687..d167d0addfe62eda9dd94a2399433606bce6efcd 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * $Id$
- *
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** 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);
 
@@ -127,11 +129,8 @@ protected:
 
 
 #ifdef WITH_CXX_GUARDEDALLOC
-public:
-       void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_TimeCategoryLogger"); }
-       void operator delete( void *mem ) { MEM_freeN(mem); }
+       MEM_CXX_CLASS_ALLOC_FUNCS("GE:KX_TimeCategoryLogger")
 #endif
 };
 
-#endif // __KX_TIME_CATEGORY_LOGGER_H
-
+#endif  /* __KX_TIMECATEGORYLOGGER_H__ */