Documentation for module 'NDK'

Former-commit-id: 7d8a51d8ad14bfb16a76b8d77c92c776bfb694ab [formerly 1dac8450f2eddf175b3eb2b6675621ea0b2a0df7] [formerly bb4300770d267df0eed5c509ec748c6866f36376 [formerly d15a100319ffc8805c7f93c9bcd936e204dad40b]]
Former-commit-id: 83a4715ed2a3220b7ef4718401d50ce584d275fc [formerly a941a150d510a51daed4322723795d90b6d56724]
Former-commit-id: f46308abb0bc577d73447f6a574ec091a50a9cca

SDK/include/NDK/System.inl

@@ -7,6 +7,18 @@
 
 namespace Ndk
 {
+	/*!
+	* \ingroup NDK
+	* \class Ndk::System<SystemType>
+	* \brief NDK class that represents a system which interacts on a world
+	*
+	* \remark This class is meant to be derived as CRTP: "System<Subtype>"
+	*/
+
+	/*!
+	* \brief Constructs a System object by default
+	*/
+
 	template<typename SystemType>
 	System<SystemType>::System() :
 	BaseSystem(GetSystemIndex<SystemType>())
@@ -16,15 +28,26 @@ namespace Ndk
 	template<typename SystemType>
 	System<SystemType>::~System() = default;
 
+	/*!
+	* \brief Clones the system
+	* \return The clone newly created
+	*
+	* \remark The system to clone should be trivially copy constructible
+	*/
+
 	template<typename SystemType>
-	BaseSystem* System<SystemType>::Clone() const
+	std::unique_ptr<BaseSystem> System<SystemType>::Clone() const
 	{
-		///FIXME: Pas encore supporté par GCC (4.9.2)
+		///FIXME: Not fully supported in GCC (4.9.2)
 		//static_assert(std::is_trivially_copy_constructible<SystemType>::value, "SystemType should be copy-constructible");
 
-		return new SystemType(static_cast<const SystemType&>(*this));
+		return std::make_unique<SystemType>(static_cast<const SystemType&>(*this));
 	}
 
+	/*!
+	* \brief Registers the system by assigning it an index
+	*/
+
 	template<typename SystemType>
 	SystemIndex System<SystemType>::RegisterSystem()
 	{