Documentation for module: Graphics

Former-commit-id: 5e3ee3c61779fbdd1a083117f537a45e1bad820b

src/Nazara/Graphics/ParticleGenerator.cpp

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