Documentation for module: Graphics

Former-commit-id: 1757c33318443aade1dc38e16d053240d7dc885c

src/Nazara/Graphics/ParticleController.cpp

@@ -7,17 +7,44 @@
 
 namespace Nz
 {
+	/*!
+	* \ingroup graphics
+	* \class Nz::ParticleController
+	* \brief Graphics class which controls a flow of particles
+	*
+	* \remark This class is abstract
+	*/
+
+	/*!
+	* \brief Constructs a ParticleController object by assignation
+	*
+	* \param controller ParticleController to copy into this
+	*/
+
 	ParticleController::ParticleController(const ParticleController& controller) :
 	RefCounted()
 	{
 		NazaraUnused(controller);
 	}
 
+	/*!
+	* \brief Destructs the object and calls OnParticleControllerRelease
+	*
+	* \see OnParticleControllerRelease
+	*/
+
 	ParticleController::~ParticleController()
 	{
 		OnParticleControllerRelease(this);
 	}
 
+	/*!
+	* \brief Initializes the particle controller librairies
+	* \return true If successful
+	*
+	* \remark Produces a NazaraError if the particle controller library failed to be initialized
+	*/
+
 	bool ParticleController::Initialize()
 	{
 		if (!ParticleControllerLibrary::Initialize())
@@ -29,6 +56,10 @@ namespace Nz
 		return true;
 	}
 
+	/*!
+	* \brief Uninitializes the particle controller librairies
+	*/
+
 	void ParticleController::Uninitialize()
 	{
 		ParticleControllerLibrary::Uninitialize();