iox-eclipse-iceoryx#468 fileheader and doxygen comments

Signed-off-by: Dietrich Krönke <[email protected]>

doc/aspice_swe3_4/CMakeLists.txt

@@ -1,18 +1,19 @@
-# Copyright (c) 2020 by Apex.AI Inc. All rights reserved.
+# Copyright (c) 2021 Apex.AI Inc. All rights reserved.
 #
-# Licensed under the Apache License, Version 2.0 (the "License"); you may not
-# use this file except in compliance with the License. You may obtain a copy of
-# the License at
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
 #
-# http://www.apache.org/licenses/LICENSE-2.0
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations under
-# the License.
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 file(STRINGS "../../VERSION" iceoryx_doc_VERSION)
 project(iceoryx_doc VERSION ${iceoryx_doc_VERSION})
@@ -79,8 +80,3 @@ install(
   DESTINATION
     ${CMAKE_CURRENT_BINARY_DIR}
 )
-
-
-
-
-

iceoryx_utils/test/integrationtests/test_resizeable_lockfree_queue_stresstest.cpp

@@ -357,11 +357,11 @@ using HalfFull3 = HalfFull<Data, Large>;
 /// need separate stress test targets and policy to run them on CI,
 /// currently only activate one suitable general configuration
 /// for this reason some less important tests are disabled for now
-/*
-typedef ::testing::
-    Types<Full1, Full2, Full3, Full4, AlmostFull1, AlmostFull2, AlmostFull3, HalfFull1, HalfFull2, HalfFull3>
-        TestConfigs;
-*/
+/// @code
+/// typedef ::testing::
+///    Types<Full1, Full2, Full3, Full4, AlmostFull1, AlmostFull2, AlmostFull3, HalfFull1, HalfFull2, HalfFull3>
+///        TestConfigs;
+/// @endcode
 typedef ::testing::Types<HalfFull2> TestConfigs;
 
 /// we require TYPED_TEST since we support gtest 1.8 for our safety targets

iceoryx_utils/test/moduletests/test_concurrent_sofi.cpp

@@ -31,67 +31,44 @@ class CUnitTestContainerSoFi : public ::testing::Test
     {
     }
 
-    /**
-     * @brief returns the ID of the current test in the format "TestCaseName.TestName"
-     *
-     * @return std::string: the id of the test
-     */
+    /// @brief returns the ID of the current test in the format "TestCaseName.TestName"
+    /// @return std::string: the id of the test
     std::string testId();
 
-    /**
-     * @brief pushes some serial numbers to the SoFi with the expectation to not overflow
-     *
-     * @param serNumStart is the offset for the serial numbers to push into the SoFi
-     * @param numberOfItems is the number of items to push into the SoFi
-     * @return int: the first not pushed serial number
-     */
+    /// @brief pushes some serial numbers to the SoFi with the expectation to not overflow
+    /// @param[in] serNumStart is the offset for the serial numbers to push into the SoFi
+    /// @param[in] numberOfItems is the number of items to push into the SoFi
+    /// @return int: the first not pushed serial number
     int pushSome(int serNumStart, uint32_t numberOfItems);
 
-    /**
-     * @brief pops some items from the SoFi with the expectation of a non empty SoFi at the last pop
-     *
-     * @param serNumOldest is the oldest serial numbers in the SoFi
-     * @param numberOfItems is the number of items to pop from the SoFi
-     */
+    /// @brief pops some items from the SoFi with the expectation of a non empty SoFi at the last pop
+    /// @param[in] serNumOldest is the oldest serial numbers in the SoFi
+    /// @param[in] numberOfItems is the number of items to pop from the SoFi
     void popSome(int serNumOldest, uint32_t numberOfItems);
 
-    /**
-     * @brief pops all items from the SoFi
-     *
-     * @param serNumOldest is the oldest serial numbers in the SoFi
-     */
+
+    /// @brief pops all items from the SoFi
+    /// @param[in] serNumOldest is the oldest serial numbers in the SoFi
     void popAll(int serNumOldest);
 
-    /**
-     * @brief checks the SoFi empty behaviour; pop on empty SoFi, pushing and popping the same amount of items
-     *
-     * @param scope is the identifier for gTest SCOPED_TRACE to trace the failure when subroutines are used
-     * @param serNumStart is the offset for the serial numbers to push into the SoFi
-     */
+    /// @brief checks the SoFi empty behaviour; pop on empty SoFi, pushing and popping the same amount of items
+    /// @param[in] scope is the identifier for gTest SCOPED_TRACE to trace the failure when subroutines are used
+    /// @param[in] serNumStart is the offset for the serial numbers to push into the SoFi
     void checkEmpty(const std::string& scope, int serNumStart);
 
-    /**
-     * @brief checks the capacity ot the SoFi
-     *
-     * @param scope is the identifier for gTest SCOPED_TRACE to trace the failure when subroutines are used
-     * @param serNumStart is the offset for the serial numbers to push into the SoFi
-     */
+    /// @brief checks the capacity ot the SoFi
+    /// @param[in] scope is the identifier for gTest SCOPED_TRACE to trace the failure when subroutines are used
+    /// @param[in] serNumStart is the offset for the serial numbers to push into the SoFi
     void checkCapacity(const std::string& scope, int serNumStart);
 
-    /**
-     * @brief checks if the SoFi overflow works as expected with one overflow
-     *
-     * @param scope is the identifier for gTest SCOPED_TRACE to trace the failure when subroutines are used
-     * @param serNumStart is the offset for the serial numbers to push into the SoFi
-     */
+    /// @brief checks if the SoFi overflow works as expected with one overflow
+    /// @param[in] scope is the identifier for gTest SCOPED_TRACE to trace the failure when subroutines are used
+    /// @param[in] serNumStart is the offset for the serial numbers to push into the SoFi
     void checkOverflow(const std::string& scope, int serNumStart);
 
-    /**
-     * @brief checks if the SoFi overflow works as expected with multiple overflowing
-     *
-     * @param scope is the identifier for gTest SCOPED_TRACE to trace the failure when subroutines are used
-     * @param serNumStart is the offset for the serial numbers to push into the SoFi
-     */
+    /// @brief checks if the SoFi overflow works as expected with multiple overflowing
+    /// @param[in] scope is the identifier for gTest SCOPED_TRACE to trace the failure when subroutines are used
+    /// @param[in] serNumStart is the offset for the serial numbers to push into the SoFi
     void checkMultiOverflow(const std::string& scope, int serNumStart);
 
     static constexpr uint64_t TEST_SOFI_CAPACITY = 10;

iceoryx_utils/test/moduletests/test_relative_pointer.cpp

@@ -449,9 +449,9 @@ TYPED_TEST(relativeptrtests, pointerOperator)
     EXPECT_EQ(*rp1, *baseAddr);
 }
 
-// central use case of the relative pointer:
-// it is tested that changing the (static) lookup table of a relative pointer causes existing
-// relative pointers point to changed locations relative to the new lookup table
+/// central use case of the relative pointer:
+/// it is tested that changing the (static) lookup table of a relative pointer causes existing
+/// relative pointers point to changed locations relative to the new lookup table
 TEST_F(RelativePointer_test, memoryRemapping)
 {
     constexpr size_t BLOCK_SIZE = 1024;

iceoryx_utils/test/moduletests/test_resizeable_lockfree_queue.cpp

@@ -17,13 +17,11 @@
 #include "iceoryx_utils/concurrent/resizeable_lockfree_queue.hpp"
 using namespace ::testing;
 
-//*********************************************************
-// Test the added functionaility of ResizeableLockFreeQueue
-// to change the capacity (setCapacity).
-// The remaining functionality is identical to LockFreeQueue
-// and tested in test_lockfree_queue.cpp (as a typed test).
-//*********************************************************
 
+/// Test the added functionality of ResizeableLockFreeQueue
+/// to change the capacity (setCapacity).
+/// The remaining functionality is identical to LockFreeQueue
+/// and tested in test_lockfree_queue.cpp (as a typed test).
 namespace
 {
 // use a non-POD type for testing (just a boxed version of int)