From dfa9695a28b6c9f23304505881f9f74ef9ef8e95 Mon Sep 17 00:00:00 2001
From: Quentin Khan <quentin@redbite.com>
Date: Wed, 18 Feb 2015 19:05:00 +0100
Subject: [PATCH] Correction of FBasicParticleContainer documentation that was
not detected by doxygen
---
Src/Components/FBasicParticleContainer.hpp | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/Src/Components/FBasicParticleContainer.hpp b/Src/Components/FBasicParticleContainer.hpp
index 2ed1b84e1..aefddd4d3 100755
--- a/Src/Components/FBasicParticleContainer.hpp
+++ b/Src/Components/FBasicParticleContainer.hpp
@@ -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 {
--
GitLab