Commit dfa9695a authored by Quentin Khan's avatar Quentin Khan Committed by Quentin Khan
Browse files

Correction of FBasicParticleContainer documentation that was not detected by doxygen

parent 63f1366f
......@@ -28,21 +28,21 @@
/**
* @author Berenger Bramas (berenger.bramas@inria.fr)
* @class FBasicParticle
* Please read the license
*
* This class defines a container which can holds one type (AttributeClass)
* for each particle.
* The memory is allocated for all informations, the positions and the
* request type.
* For example is one want to store a struct for each particle:
* @code
* @code struct AStruct{
* @code ...
* @code };
* @code FBasicParticleContainer<1, AStruct> container;
* And then the access is done using:
* @code AStruct* strucs = container.getAttributes<0>();
* For example if one wants to store a struct for each particle:
* \code
* struct AStruct{ ... };
* FBasicParticleContainer<1, AStruct> container;
* \endcode
* And then access is done using:
* \code
* AStruct* strucs = container.getAttributes<0>();
* \endcode
*/
template <unsigned NbAttributesPerParticle, class AttributeClass = FReal >
class FBasicParticleContainer : public FAbstractParticleContainer, public FAbstractSerializable {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment