Document VectorAlignment and MemoryAlignment

Signed-off-by: Matthias Kretz <kretz@kde.org>
VcDevel · Nov 24, 2015 · 80178fe · 80178fe
1 parent f94106f
commit 80178fe
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/include/Vc/vector.h b/include/Vc/vector.h
@@ -151,7 +151,27 @@ namespace Vc_VERSIONED_NAMESPACE
 
 #include "common/alignedbase.h"
 namespace Vc_VERSIONED_NAMESPACE {
+/**
+ * \ingroup Vectors
+ *
+ * Specifies the most conservative memory alignment necessary for Vector<T> objects with
+ * default VectorAbi. Use this value e.g. with an \c alignas expression or when allocating
+ * aligned memory dynamically (\ref Vc::malloc).
+ *
+ * \see Vc::MemoryAlignment
+ * \see Vc::VectorAlignedBase
+ */
 constexpr std::size_t VectorAlignment = alignof(VectorAlignedBase);
+/**
+ * \ingroup Vectors
+ *
+ * Specifies the most conservative memory alignment necessary for aligned loads and stores
+ * of Vector types. Use this value e.g. with an \c alignas expression or when allocating
+ * aligned memory dynamically (\ref Vc::malloc).
+ *
+ * \see Vc::VectorAlignment
+ * \see Vc::Vector<T, Abi>::MemoryAlignment
+ */
 constexpr std::size_t MemoryAlignment = alignof(MemoryAlignedBase);
 } // namespace Vc_VERSIONED_NAMESPACE