Merge pull request #214 from krasznaa/DoxygenNamespaceFix-main-20230117

Doxygen Namespace Fixes, main branch (2023.01.17.)
acts-project · Jan 18, 2023 · 7d47188 · 7d47188
2 parents 20bd269 + f262d8b
commit 7d47188
Show file tree

Hide file tree

Showing 121 changed files with 147 additions and 122 deletions.
diff --git a/benchmarks/core/benchmark_core.cpp b/benchmarks/core/benchmark_core.cpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/benchmarks/cuda/benchmark_cuda.cpp b/benchmarks/cuda/benchmark_cuda.cpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/benchmarks/sycl/benchmark_sycl.cpp b/benchmarks/sycl/benchmark_sycl.cpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021-2022 CERN for the benefit of the ACTS project
  *

diff --git a/core/cmake/atomic_ref_test.sycl b/core/cmake/atomic_ref_test.sycl
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2022 CERN for the benefit of the ACTS project
  *

diff --git a/core/cmake/ext_oneapi_printf_test.sycl b/core/cmake/ext_oneapi_printf_test.sycl
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/cmake/oneapi_printf_test.sycl b/core/cmake/oneapi_printf_test.sycl
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/array.hpp b/core/include/vecmem/containers/array.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/const_device_array.hpp b/core/include/vecmem/containers/const_device_array.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/const_device_vector.hpp b/core/include/vecmem/containers/const_device_vector.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/data/vector_buffer.hpp b/core/include/vecmem/containers/data/vector_buffer.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021-2022 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/data/vector_view.hpp b/core/include/vecmem/containers/data/vector_view.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *
@@ -15,6 +15,13 @@
 #include <type_traits>
 
 namespace vecmem {
+
+/// @brief Namespace holding "data types"
+///
+/// These are types that either own, or only provide a view of data owned by
+/// some other component. They are used for "non-interactive" data management
+/// in the code.
+///
 namespace data {
 
 /// Class holding data about a 1 dimensional vector/array

diff --git a/core/include/vecmem/containers/details/reverse_iterator.hpp b/core/include/vecmem/containers/details/reverse_iterator.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/details/static_array_traits.hpp b/core/include/vecmem/containers/details/static_array_traits.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/details/static_vector_traits.hpp b/core/include/vecmem/containers/details/static_vector_traits.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *
@@ -10,6 +10,12 @@
 #include <cstddef>
 
 namespace vecmem {
+
+/// @brief Namespace for types that should not be used directly by clients
+///
+/// These would be classes/functions/types that are needed by the public
+/// interface of classes/functions outside of this namespace.
+///
 namespace details {
 
 /// Helper type for an array in a static_vector with a given type and size

diff --git a/core/include/vecmem/containers/device_array.hpp b/core/include/vecmem/containers/device_array.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/device_vector.hpp b/core/include/vecmem/containers/device_vector.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021-2022 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/impl/array.ipp b/core/include/vecmem/containers/impl/array.ipp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/impl/device_array.ipp b/core/include/vecmem/containers/impl/device_array.ipp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/impl/device_vector.ipp b/core/include/vecmem/containers/impl/device_vector.ipp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021-2022 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/impl/reverse_iterator.ipp b/core/include/vecmem/containers/impl/reverse_iterator.ipp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/impl/static_array.ipp b/core/include/vecmem/containers/impl/static_array.ipp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/containers/impl/static_vector.ipp b/core/include/vecmem/containers/impl/static_vector.ipp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/impl/vector.ipp b/core/include/vecmem/containers/impl/vector.ipp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/impl/vector_buffer.ipp b/core/include/vecmem/containers/impl/vector_buffer.ipp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021-2022 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/impl/vector_view.ipp b/core/include/vecmem/containers/impl/vector_view.ipp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/static_array.hpp b/core/include/vecmem/containers/static_array.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/containers/static_vector.hpp b/core/include/vecmem/containers/static_vector.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/containers/vector.hpp b/core/include/vecmem/containers/vector.hpp
@@ -1,6 +1,6 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
- * (c) 2021 CERN for the benefit of the ACTS project
+ * (c) 2021-2023 CERN for the benefit of the ACTS project
  *
  * Mozilla Public License Version 2.0
  */
@@ -13,6 +13,13 @@
 // System include(s).
 #include <vector>
 
+/// @brief Main namespace for the vecmem classes/functions
+///
+/// Public classes and functions that are not language/backend specific, are
+/// generally placed in this namespace.
+///
+/// @see @c vecmem::data
+///
 namespace vecmem {
 /**
  * @brief Alias type for vectors with our polymorphic allocator

diff --git a/core/include/vecmem/memory/binary_page_memory_resource.hpp b/core/include/vecmem/memory/binary_page_memory_resource.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/memory/choice_memory_resource.hpp b/core/include/vecmem/memory/choice_memory_resource.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/memory/coalescing_memory_resource.hpp b/core/include/vecmem/memory/coalescing_memory_resource.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/memory/conditional_memory_resource.hpp b/core/include/vecmem/memory/conditional_memory_resource.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/memory/contiguous_memory_resource.hpp b/core/include/vecmem/memory/contiguous_memory_resource.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/memory/debug_memory_resource.hpp b/core/include/vecmem/memory/debug_memory_resource.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/memory/details/is_aligned.hpp b/core/include/vecmem/memory/details/is_aligned.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2022 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/memory/details/memory_resource_base.hpp b/core/include/vecmem/memory/details/memory_resource_base.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/memory/host_memory_resource.hpp b/core/include/vecmem/memory/host_memory_resource.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021-2022 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/memory/identity_memory_resource.hpp b/core/include/vecmem/memory/identity_memory_resource.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/memory/instrumenting_memory_resource.hpp b/core/include/vecmem/memory/instrumenting_memory_resource.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/memory/memory_resource.hpp b/core/include/vecmem/memory/memory_resource.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/memory/polymorphic_allocator.hpp b/core/include/vecmem/memory/polymorphic_allocator.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/memory/terminal_memory_resource.hpp b/core/include/vecmem/memory/terminal_memory_resource.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/utils/debug.hpp b/core/include/vecmem/utils/debug.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/utils/memory_monitor.hpp b/core/include/vecmem/utils/memory_monitor.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/include/vecmem/utils/type_traits.hpp b/core/include/vecmem/utils/type_traits.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/include/vecmem/utils/types.hpp b/core/include/vecmem/utils/types.hpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/src/memory/binary_page_memory_resource.cpp b/core/src/memory/binary_page_memory_resource.cpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/src/memory/binary_page_memory_resource_impl.cpp b/core/src/memory/binary_page_memory_resource_impl.cpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021-2022 CERN for the benefit of the ACTS project

diff --git a/core/src/memory/binary_page_memory_resource_impl.hpp b/core/src/memory/binary_page_memory_resource_impl.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/src/memory/choice_memory_resource.cpp b/core/src/memory/choice_memory_resource.cpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/src/memory/coalescing_memory_resource.cpp b/core/src/memory/coalescing_memory_resource.cpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/src/memory/conditional_memory_resource.cpp b/core/src/memory/conditional_memory_resource.cpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/src/memory/contiguous_memory_resource.cpp b/core/src/memory/contiguous_memory_resource.cpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/src/memory/debug_memory_resource.cpp b/core/src/memory/debug_memory_resource.cpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project

diff --git a/core/src/memory/default_resource_polyfill.cpp b/core/src/memory/default_resource_polyfill.cpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/src/memory/details/is_aligned.cpp b/core/src/memory/details/is_aligned.cpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2022 CERN for the benefit of the ACTS project

diff --git a/core/src/memory/details/memory_resource_base.cpp b/core/src/memory/details/memory_resource_base.cpp
@@ -1,4 +1,4 @@
-/** VecMem project, part of the ACTS project (R&D line)
+/* VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project
  *

diff --git a/core/src/memory/host_memory_resource.cpp b/core/src/memory/host_memory_resource.cpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021-2022 CERN for the benefit of the ACTS project

diff --git a/core/src/memory/identity_memory_resource.cpp b/core/src/memory/identity_memory_resource.cpp
@@ -1,4 +1,4 @@
-/**
+/*
  * VecMem project, part of the ACTS project (R&D line)
  *
  * (c) 2021 CERN for the benefit of the ACTS project