Documentation for module 'NDK'

Former-commit-id: a6c2075cfbfd0eccf2b77def71c0d42684bed590 [formerly 36ece2bc6a148bde6cacf45084821d20edcd115e] [formerly 4a6988792ec026e65be6850c46dfe8ddda92a885 [formerly fd3f4f975de5c427f3adc98b220446fd255be396]]
Former-commit-id: c87fdc9483202842267c60eff3d619f0df2963bf [formerly ee35202f1b2df7ca20da5b6d8b13147f2b92c933]
Former-commit-id: dad5de1b00bb4413f7aa191ca06b7d43b659f32a

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()
 	{