added a bit of documentation

Author: Alessio Linares

Core.h

@@ -15,4 +15,14 @@
 #include "Core/Transform.h"
 #include "Core/Vector2d.h"
 #include "Core/Vector3d.h"
-#endif
+#endif
+
+/**
+ * \defgroup core Hummingbird Core
+ * \brief Core classes of the Hummingbird Framework.
+ */
+/**
+ * \defgroup core-components Components
+ * \brief Function and Data component
+ * \ingroup core
+ */

Core/Clock.h

@@ -5,7 +5,6 @@
 
 namespace hb
 {
-	//! A class for measuring time intervals
 	class Clock
 	{
 	public:
@@ -27,3 +26,10 @@ namespace hb
 	};
 }
 #endif
+
+/**
+ * \class hb::Clock
+ * \ingroup core
+ *
+ * A class for measuring time intervals
+ */

Core/Color.h

@@ -33,3 +33,10 @@ namespace hb
 }
 
 #endif
+
+/**
+ * \struct hb::Color
+ * \ingroup core
+ * 
+ * Struct representing a color RGBA of floats [0, 1]
+ */

Core/DataComponent.h

@@ -4,6 +4,10 @@
 
 namespace hb
 {
+	/*!
+	  \class DataComponent
+	  \ingroup core-components
+	*/
 	template <typename T>
 	class DataComponent : public GameObject::Component
 	{

Core/DataRepository.h

@@ -5,6 +5,10 @@
 
 namespace hb
 {
+	/*!
+	  \class DataRepository
+	  \ingroup core
+	*/
 	class DataRepository
 	{
 	public:

Core/FunctionComponent.h

@@ -6,6 +6,10 @@
 
 namespace hb
 {
+	/*!
+	  \class FunctionComponent
+	  \ingroup core-components
+	*/
 	class FunctionComponent : public GameObject::Component
 	{
 	public:

Core/Game.h

@@ -11,6 +11,10 @@
 
 namespace hb
 {
+	/*!
+	  \class Game
+	  \ingroup core
+	*/
 	class Game
 	{
 	public:

Core/GameObject.cpp

@@ -72,7 +72,7 @@ m_marked_to_destroy(false)
 }
 
 
-GameObject::GameObject(const std::initializer_list<GameObject::Component*>& components):
+GameObject::GameObject(const std::initializer_list<Component*>& components):
 GameObject()
 {
 	for (Component* c : components)

Core/GameObject.h

@@ -12,6 +12,10 @@
 
 namespace hb
 {
+	/*!
+	  \class GameObject
+	  \ingroup core
+	*/
 	class GameObject : public Transform
 	{
 	public:

Core/Makefile

@@ -12,7 +12,7 @@ OBJ       := $(addprefix ./,$(SOURCES:./%.cpp=%.o))
 all: $(OBJ)
 
 %.o: %.cpp
-	$(CC) -c -o $@ $< $(CFLAGS) -O3
+	$(CC) -c -o $@ $< $(CFLAGS)
 	ar rvs $(STATIC_LIB_NAME).a $@
 
 .PHONY: clean

Core/Plugin.h

@@ -6,6 +6,10 @@
 
 namespace hb
 {
+	/*!
+	  \class Plugin
+	  \ingroup core
+	*/
 	class Plugin
 	{
 	public:

Core/Resource.h

@@ -4,6 +4,10 @@
 
 namespace hb
 {
+	/*!
+	  \class Resource
+	  \ingroup core
+	*/
 	template <typename ResourceType, typename ResourceId, typename ResourceManager>
 	class Resource
 	{

Core/ResourceManager.h

@@ -5,6 +5,10 @@
 
 namespace hb
 {
+	/*!
+	  \class ResourceManager
+	  \ingroup core
+	*/
 	template <typename ManagerType, typename Resource, typename ResourceId, typename Hash = std::hash<ResourceId>>
 	class ResourceManager
 	{

Core/Time.h

@@ -3,6 +3,10 @@
 
 namespace hb
 {
+	/*!
+	  \class Time
+	  \ingroup core
+	*/
 	class Time
 	{
 	public:

Core/Transform.h

@@ -4,6 +4,10 @@
 
 namespace hb
 {
+	/*!
+	  \class Transform
+	  \ingroup core
+	*/
 	class Transform
 	{
 	public:

Core/Vector2d.h

@@ -57,3 +57,10 @@ hb::Vector2d& operator /=(hb::Vector2d& left, double right);
 bool operator ==(const hb::Vector2d& left, const hb::Vector2d& right);
 bool operator !=(const hb::Vector2d& left, const hb::Vector2d& right);
 #endif
+
+/**
+ * \class hb::Vector2d
+ * \ingroup core
+ *
+ * A 2d vector of doubles
+ */

Core/Vector3d.h

@@ -7,6 +7,10 @@
 
 namespace hb
 {
+	/*!
+	  \class Vector3d
+	  \ingroup core
+	*/
 	class Vector3d
 	{
 	public: