Add some \internal documentation

Signed-off-by: Matthias Kretz <kretz@kde.org>
VcDevel · Nov 24, 2015 · 210030d · 210030d
1 parent f99a327
commit 210030d
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/common/interleavedmemory.h b/common/interleavedmemory.h
@@ -125,6 +125,7 @@ struct InterleavedMemoryReadAccess : public InterleavedMemoryAccessBase<V, I, Re
     }
 };
 
+///\internal Runtime check (NDEBUG) for asserting unique indexes.
 template<typename I> struct CheckIndexesUnique
 {
 #ifdef NDEBUG
@@ -137,6 +138,7 @@ template<typename I> struct CheckIndexesUnique
     }
 #endif
 };
+///\internal For SuccessiveEntries there can never be a problem.
 template<size_t S> struct CheckIndexesUnique<SuccessiveEntries<S> >
 {
     static Vc_INTRINSIC void test(const SuccessiveEntries<S> &) {}

diff --git a/common/loadstoreflags.h b/common/loadstoreflags.h
@@ -83,6 +83,10 @@ template<typename Base, typename Default, typename T, typename... LoadStoreFlags
 #ifdef Vc_ICC
 #pragma warning(disable: 177)
 #endif
+/**\internal
+ * Implementation of the load/store flags mechanism. This is internal API. Only some
+ * concrete aliases are API-relevant types.
+ */
 template<typename... Flags> struct LoadStoreFlags
 {
 private:
@@ -118,6 +122,9 @@ template<typename... Flags> struct LoadStoreFlags
     typedef typename std::conditional<!IsPrefetch                , void *, void>::type EnableIfNotPrefetch;
 };
 
+/**\internal
+ * Specialization for no flags (i.e aligned, non-streaming, no prefetching)
+ */
 template<> struct LoadStoreFlags<>
 {
     constexpr LoadStoreFlags() {}
@@ -171,10 +178,13 @@ struct Prefetch : public LoadStoreFlags::LoadStoreFlags<PrefetchFlag<L1, L2, Exc
 
 namespace Traits
 {
+///\internal partial specialization for detecting LoadStoreFlags types
 template <typename... Ts>
 struct is_loadstoreflag_internal<LoadStoreFlags::LoadStoreFlags<Ts...>> : public std::true_type
 {
 };
+///\internal partial specialization for detecting the derived Prefetch type as a
+/// load/store flag.
 template <size_t L1, size_t L2, typename ExclusiveOrShared>
 struct is_loadstoreflag_internal<Prefetch<L1, L2, ExclusiveOrShared>> : public std::true_type
 {

diff --git a/common/simdize.h b/common/simdize.h
@@ -334,23 +334,29 @@ struct SubstituteOneByOne<N, MT, Typelist<Replaced...>, T, Remaining...>
                                              Remaining...>::type;
 };
 
+///\internal Generates the SubstitutedWithValues member. This needs specialization for the
+/// number of types in the template argument list.
 template <size_t Size, typename... Replaced> struct SubstitutedBase;
+///\internal Specialization for one type parameter.
 template <typename Replaced> struct SubstitutedBase<1, Replaced> {
     template <typename ValueT, template <typename, ValueT...> class C, ValueT... Values>
     using SubstitutedWithValues = C<Replaced, Values...>;
 };
+///\internal Specialization for two type parameters.
 template <typename R0, typename R1> struct SubstitutedBase<2, R0, R1>
 {
     template <typename ValueT, template <typename, typename, ValueT...> class C,
               ValueT... Values>
     using SubstitutedWithValues = C<R0, R1, Values...>;
 };
+///\internal Specialization for three type parameters.
 template <typename R0, typename R1, typename R2> struct SubstitutedBase<3, R0, R1, R2>
 {
     template <typename ValueT, template <typename, typename, typename, ValueT...> class C,
               ValueT... Values>
     using SubstitutedWithValues = C<R0, R1, R2, Values...>;
 };
+///\internal Specialization for four type parameters.
 template <typename... Replaced> struct SubstitutedBase<4, Replaced...> {
 #ifndef Vc_ICC
     template <typename ValueT,
@@ -359,6 +365,7 @@ template <typename... Replaced> struct SubstitutedBase<4, Replaced...> {
     using SubstitutedWithValues = C<Replaced..., Values...>;
 #endif // Vc_ICC
 };
+///\internal Specialization for five type parameters.
 template <typename... Replaced> struct SubstitutedBase<5, Replaced...> {
 #ifndef Vc_ICC
     template <typename ValueT, template <typename, typename, typename, typename, typename,
@@ -367,6 +374,7 @@ template <typename... Replaced> struct SubstitutedBase<5, Replaced...> {
     using SubstitutedWithValues = C<Replaced..., Values...>;
 #endif // Vc_ICC
 };
+///\internal Specialization for six type parameters.
 template <typename... Replaced> struct SubstitutedBase<6, Replaced...> {
 #ifndef Vc_ICC
     template <typename ValueT, template <typename, typename, typename, typename, typename,
@@ -375,6 +383,7 @@ template <typename... Replaced> struct SubstitutedBase<6, Replaced...> {
     using SubstitutedWithValues = C<Replaced..., Values...>;
 #endif // Vc_ICC
 };
+///\internal Specialization for seven type parameters.
 template <typename... Replaced> struct SubstitutedBase<7, Replaced...> {
 #ifndef Vc_ICC
     template <typename ValueT, template <typename, typename, typename, typename, typename,
@@ -383,6 +392,7 @@ template <typename... Replaced> struct SubstitutedBase<7, Replaced...> {
     using SubstitutedWithValues = C<Replaced..., Values...>;
 #endif // Vc_ICC
 };
+///\internal Specialization for eight type parameters.
 template <typename... Replaced> struct SubstitutedBase<8, Replaced...> {
 #ifndef Vc_ICC
     template <typename ValueT, template <typename, typename, typename, typename, typename,