base/time: make get_time static, constructor protected

The Time class does not have any state so the get_time method could be
static. Because the Time class now has only static methods, deny
creation by making the ctor protected.

2 files changed, 18 insertions, 3 deletions

diff --git a/src/base/time.cpp b/src/base/time.cpp
index 923b47cd..f4d37e7a 100644
--- a/src/base/time.cpp
+++ b/src/base/time.cpp
@@ -29,7 +29,6 @@
 
 namespace usdx
 {
-
 	Time::Time(void)
 	{
 	}
diff --git a/src/base/time.hpp b/src/base/time.hpp
index 229ac3e1..9e9eac20 100644
--- a/src/base/time.hpp
+++ b/src/base/time.hpp
@@ -27,11 +27,27 @@
 
 namespace usdx
 {
+	/**
+	 * Simple static-only wrapper class to get a time. This time does not need
+	 * to correspond to the real clock. It should only be a changing number,
+	 * that change at the same speed like the real clock. The current
+	 * implementation uses SDL and returns the milliseconds since initialization
+	 * of the library.
+	 */
 	class Time
 	{
-	public:
+	protected:
+		/**
+		 * Protected constructor. This class currently contains only static
+		   methods. So there should no need to create an instance of it.
+		 */
 		Time(void);
-		float get_time();
+
+	public:
+		/**
+		 * Returns the current "time" as milliseconds.
+		 */
+		static float get_time();
 	};
 };