iox-eclipse-iceoryx#261 attention all the things

Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>

iceoryx_utils/include/iceoryx_utils/cxx/function_ref.hpp

@@ -50,7 +50,7 @@ struct is_function_ref<function_ref<Targs...>> : std::true_type
 ///         * Stateful lambda support
 ///         * C++11/14 support
 ///
-/// @note   Invoking an empty function_ref can lead to a program termination!
+/// @attention Invoking an empty function_ref can lead to a program termination!
 ///
 /// @code
 ///         // Usage as function parameter
@@ -98,7 +98,7 @@ class function_ref<ReturnType(ArgTypes...)>
     /// @brief Calls the provided callable
     /// @param[in] Arguments are forwarded to the underlying function pointer
     /// @return Returns the data type of the underlying function pointer
-    /// @note Invoking an empty function_ref can lead to a program termination!
+    /// @attention Invoking an empty function_ref can lead to a program termination!
     ReturnType operator()(ArgTypes... args) const noexcept;
 
     /// @brief Checks whether a valid target is contained

iceoryx_utils/include/iceoryx_utils/cxx/vector.hpp

@@ -103,42 +103,42 @@ class vector
 
     /// @brief returns a reference to the element stored at index. the behavior
     //          is undefined if the element at index does not exist.
-    /// @note Out of bounds access can lead to a program termination!
+    /// @attention Out of bounds access can lead to a program termination!
     T& at(const uint64_t index) noexcept;
 
     /// @brief returns a const reference to the element stored at index. the
     ///         behavior is undefined if the element at index does not exist.
-    /// @note Out of bounds access can lead to a program termination!
+    /// @attention Out of bounds access can lead to a program termination!
     const T& at(const uint64_t index) const noexcept;
 
     /// @brief returns a reference to the element stored at index. the behavior
     //          is undefined if the element at index does not exist.
-    /// @note Out of bounds access can lead to a program termination!
+    /// @attention Out of bounds access can lead to a program termination!
     T& operator[](const uint64_t index) noexcept;
 
     /// @brief returns a const reference to the element stored at index. the
     ///         behavior is undefined if the element at index does not exist.
-    /// @note Out of bounds access can lead to a program termination!
+    /// @attention Out of bounds access can lead to a program termination!
     const T& operator[](const uint64_t index) const noexcept;
 
     /// @brief returns a reference to the first element; terminates if the vector is empty
     /// @return reference to the first element
-    /// @note Accessing an empty vector can lead to a program termination!
+    /// @attention Accessing an empty vector can lead to a program termination!
     T& front() noexcept;
 
     /// @brief returns a const reference to the first element; terminates if the vector is empty
     /// @return const reference to the first element
-    /// @note Accessing an empty vector can lead to a program termination!
+    /// @attention Accessing an empty vector can lead to a program termination!
     const T& front() const noexcept;
 
     /// @brief returns a reference to the last element; terminates if the vector is empty
     /// @return reference to the last element
-    /// @note Accessing an empty vector can lead to a program termination!
+    /// @attention Accessing an empty vector can lead to a program termination!
     T& back() noexcept;
 
     /// @brief returns a const reference to the last element; terminates if the vector is empty
     /// @return const reference to the last element
-    /// @note Accessing an empty vector can lead to a program termination!
+    /// @attention Accessing an empty vector can lead to a program termination!
     const T& back() const noexcept;
 
     /// @brief returns the capacity of the vector which was given via the template

iceoryx_utils/include/iceoryx_utils/internal/cxx/vector.inl

@@ -300,7 +300,6 @@ inline const T& vector<T, Capacity>::front() const noexcept
 template <typename T, uint64_t Capacity>
 inline T& vector<T, Capacity>::back() noexcept
 {
-    // No empty vector shall be accessed
     cxx::Expects(!empty() && "Attempting to access the back of an empty vector");
     return at(size() - 1u);
 }

iceoryx_utils/include/iceoryx_utils/internal/posix_wrapper/mutex.hpp

@@ -58,10 +58,10 @@ namespace posix
 class mutex
 {
   public:
-    /// @note the construction of the mutex can fail. This can lead to a program termination!
+    /// @attention the construction of the mutex can fail. This can lead to a program termination!
     mutex(const bool f_isRecursive);
 
-    /// @note the destruction of the mutex can fail. This can lead to a program termination!
+    /// @attention the destruction of the mutex can fail. This can lead to a program termination!
     ~mutex();
 
     /// @brief all copy and move assignment methods need to be deleted otherwise