Improve documentation

Former-commit-id: 08d70f6a53a7f12d2748d145d1fe139595a1b39e

src/Nazara/Core/AbstractHash.cpp

@@ -18,7 +18,8 @@
 namespace Nz
 {
 	/*!
-	* \class Nz::AbstractHash<T>
+	* \ingroup core
+	* \class Nz::AbstractHash
 	* \brief Core class that represents the behaviour of the hash classes
 	*
 	* \remark This class is abstract

src/Nazara/Core/AbstractLogger.cpp

@@ -21,7 +21,8 @@ namespace Nz
 	}
 
 	/*!
-	* \class Nz::AbstractLogger<T>
+	* \ingroup core
+	* \class Nz::AbstractLogger
 	* \brief Core class that represents the behaviour of the log classes
 	*
 	* \remark This class is abstract

src/Nazara/Core/ByteArray.cpp

@@ -10,6 +10,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::ByteArray
 	* \brief Core class that represents an array of bytes
 	*/

src/Nazara/Core/ByteStream.cpp

@@ -12,6 +12,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::ByteStream
 	* \brief Core class that represents a stream of bytes
 	*/

src/Nazara/Core/Clock.cpp

@@ -42,6 +42,7 @@ namespace Nz
 	}
 
 	/*!
+	* \ingroup core
 	* \class Nz::Clock
 	* \brief Utility class that measure the elapsed time
 	*/
@@ -52,7 +53,6 @@ namespace Nz
 	* \param startingValue The starting time value, in microseconds
 	* \param paused The clock pause state
 	*/
-
 	Clock::Clock(UInt64 startingValue, bool paused) :
 	m_elapsedTime(startingValue),
 	m_refTime(GetElapsedMicroseconds()),
@@ -66,7 +66,6 @@ namespace Nz
 	*
 	* \see GetMicroseconds, GetMilliseconds
 	*/
-
 	float Clock::GetSeconds() const
 	{
 		return GetMicroseconds()/1000000.f;
@@ -78,7 +77,6 @@ namespace Nz
 	*
 	* \see GetMilliseconds, GetSeconds
 	*/
-
 	UInt64 Clock::GetMicroseconds() const
 	{
 		NazaraLock(m_mutex);
@@ -96,7 +94,6 @@ namespace Nz
 	*
 	* \see GetMicroseconds, GetSeconds
 	*/
-
 	UInt64 Clock::GetMilliseconds() const
 	{
 		return GetMicroseconds()/1000;
@@ -108,7 +105,6 @@ namespace Nz
 	*
 	* \see Pause, Unpause
 	*/
-
 	bool Clock::IsPaused() const
 	{
 		NazaraLock(m_mutex);
@@ -124,7 +120,6 @@ namespace Nz
 	*
 	* \see IsPaused, Unpause
 	*/
-
 	void Clock::Pause()
 	{
 		NazaraLock(m_mutex);
@@ -140,7 +135,6 @@ namespace Nz
 	* \brief Restart the clock
 	* Restarts the clock, putting it's time counter back to zero (as if the clock got constructed).
 	*/
-
 	void Clock::Restart()
 	{
 		NazaraLock(m_mutex);
@@ -158,7 +152,6 @@ namespace Nz
 	*
 	* \see IsPaused, Unpause
 	*/
-
 	void Clock::Unpause()
 	{
 		NazaraLock(m_mutex);

src/Nazara/Core/ConditionVariable.cpp

@@ -19,6 +19,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::ConditionVariable
 	* \brief Core class that represents a condition variable
 	*

src/Nazara/Core/Core.cpp

@@ -14,7 +14,8 @@
 namespace Nz
 {
 	/*!
-	* \class Nz::CoreCore
+	* \ingroup core
+	* \class Nz::Core
 	* \brief Core class that represents the module initializer of Core
 	*/
 

src/Nazara/Core/Directory.cpp

@@ -35,6 +35,7 @@ namespace Nz
 	}
 
 	/*!
+	* \ingroup core
 	* \class Nz::Directory
 	* \brief Core class that represents a directory
 	*/

src/Nazara/Core/DynLib.cpp

@@ -26,6 +26,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::DynLib
 	* \brief Core class that represents a dynamic library loader
 	*/

src/Nazara/Core/Error.cpp

@@ -19,6 +19,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::Error
 	* \brief Core class that represents an error
 	*/

src/Nazara/Core/ErrorFlags.cpp

@@ -9,6 +9,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::ErrorFlags
 	* \brief Core class that represents flags for error
 	*/

src/Nazara/Core/File.cpp

@@ -31,6 +31,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::File
 	* \brief Core class that represents a file
 	*/

src/Nazara/Core/FileLogger.cpp

@@ -13,6 +13,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::FileLogger
 	* \brief Core class that represents a file logger
 	*/

src/Nazara/Core/GuillotineBinPack.cpp

@@ -17,6 +17,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::GuillotineBinPack
 	* \brief Core class that represents the "Guillotine problem", combination of the "Bin packing problem" and the "cutting stock"
 	*/

src/Nazara/Core/HardwareInfo.cpp

@@ -83,6 +83,7 @@ namespace Nz
 	}
 
 	/*!
+	* \ingroup core
 	* \class Nz::HardwareInfo
 	* \brief Core class that represents the info we can get from hardware
 	*/

src/Nazara/Core/LockGuard.cpp

@@ -9,6 +9,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::LockGuard
 	* \brief Core class that represents a mutex wrapper that provides a convenient RAII-style mechanism
 	*/

src/Nazara/Core/Log.cpp

@@ -16,6 +16,7 @@ namespace Nz
 	}
 
 	/*!
+	* \ingroup core
 	* \class Nz::Log
 	* \brief Core class that represents a logger
 	*/

src/Nazara/Core/MemoryManager.cpp

@@ -67,6 +67,7 @@ namespace Nz
 	}
 	
 	/*!
+	* \ingroup core
 	* \class Nz::MemoryManager
 	* \brief Core class that represents a manager for the memory
 	*/

src/Nazara/Core/MemoryStream.cpp

@@ -11,6 +11,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::MemoryStream
 	* \brief Core class that represents a stream of memory
 	*/

src/Nazara/Core/MemoryView.cpp

@@ -10,6 +10,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::MemoryView
 	* \brief Core class that represents a view of the memory behaving like a stream
 	*/
@@ -134,7 +135,7 @@ namespace Nz
 	{
 		std::size_t endPos = static_cast<std::size_t>(m_pos + size);
 		if (endPos > m_size)
-			size = m_size - m_pos;
+			size = static_cast<std::size_t>(m_size - m_pos);
 
 		NazaraAssert(buffer, "Invalid buffer");
 

src/Nazara/Core/Mutex.cpp

@@ -18,6 +18,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::Mutex
 	* \brief Core class that represents a binary semaphore, a mutex
 	*

src/Nazara/Core/ParameterList.cpp

@@ -13,6 +13,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::ParameterList
 	* \brief Core class that represents a list of parameters
 	*/

src/Nazara/Core/PluginManager.cpp

@@ -25,6 +25,7 @@ namespace Nz
 	}
 
 	/*!
+	* \ingroup core
 	* \class Nz::PluginManager
 	* \brief Core class that represents a manager for plugin
 	*/

src/Nazara/Core/PrimitiveList.cpp

@@ -9,6 +9,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::PrimitiveList
 	* \brief Core class that represents a list of geometric primitives
 	*/

src/Nazara/Core/RefCounted.cpp

@@ -17,6 +17,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::RefCounted
 	* \brief Core class that represents a reference with a counter
 	*/

src/Nazara/Core/Resource.cpp

@@ -8,6 +8,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::Resource
 	* \brief Core class that represents a resource
 	*/

src/Nazara/Core/Semaphore.cpp

@@ -17,6 +17,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::Semaphore
 	* \brief Core class that represents a counting semaphore
 	*/

src/Nazara/Core/StdLogger.cpp

@@ -21,6 +21,7 @@ namespace Nz
 	}
 
 	/*!
+	* \ingroup core
 	* \class Nz::StdLogger
 	* \brief Core class that represents a logger writing to standard output (stdout, stderr)
 	*/

src/Nazara/Core/Stream.cpp

@@ -12,6 +12,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::Stream
 	* \brief Core class that represents a stream
 	*/

src/Nazara/Core/String.cpp

@@ -77,6 +77,7 @@ namespace Nz
 	}
 
 	/*!
+	* \ingroup core
 	* \class Nz::String
 	* \brief Core class that represents a string
 	*/

src/Nazara/Core/StringStream.cpp

@@ -8,6 +8,7 @@
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::StringStream
 	* \brief Core class that represents a stream of strings
 	*/

src/Nazara/Core/TaskScheduler.cpp

@@ -25,7 +25,8 @@ namespace Nz
 	}
 
 	/*!
-	* \class Nz::TaskScheduler<T>
+	* \ingroup core
+	* \class Nz::TaskScheduler
 	* \brief Core class that represents a pool of threads
 	*
 	* \remark Initialized should be called first

src/Nazara/Core/Thread.cpp

@@ -22,7 +22,8 @@
 namespace Nz
 {
 	/*!
-	* \class Nz::Thread<T>
+	* \ingroup core
+	* \class Nz::Thread
 	* \brief Core class that represents a thread
 	*/
 

src/Nazara/Core/Unicode.cpp

@@ -26,6 +26,7 @@ namespace Nz
 namespace Nz
 {
 	/*!
+	* \ingroup core
 	* \class Nz::Unicode
 	* \brief Core class that represents a Unicode character
 	*/