Documentation for module: Graphics

Former-commit-id: 1757c33318443aade1dc38e16d053240d7dc885c

src/Nazara/Graphics/ParticleRenderer.cpp

@@ -7,17 +7,42 @@
 
 namespace Nz
 {
+	/*!
+	* \ingroup graphics
+	* \class Nz::ParticleRenderer
+	* \brief Graphics class that represents the rendering of the particle
+	*/
+
+	/*!
+	* \brief Constructs a ParticleRenderer object by assignation
+	*
+	* \param renderer ParticleRenderer to copy into this
+	*/
+
 	ParticleRenderer::ParticleRenderer(const ParticleRenderer& renderer) :
 	RefCounted()
 	{
 		NazaraUnused(renderer);
 	}
 
+	/*!
+	* \brief Destructs the object and calls OnParticleRendererRelease
+	*
+	* \see OnParticleRendererRelease
+	*/
+
 	ParticleRenderer::~ParticleRenderer()
 	{
 		OnParticleRendererRelease(this);
 	}
 
+	/*!
+	* \brief Initializes the particle renderer librairies
+	* \return true If successful
+	*
+	* \remark Produces a NazaraError if the particle renderer library failed to be initialized
+	*/
+
 	bool ParticleRenderer::Initialize()
 	{
 		if (!ParticleRendererLibrary::Initialize())
@@ -29,6 +54,10 @@ namespace Nz
 		return true;
 	}
 
+	/*!
+	* \brief Uninitializes the particle renderer librairies
+	*/
+
 	void ParticleRenderer::Uninitialize()
 	{
 		ParticleRendererLibrary::Uninitialize();