iox-eclipse-iceoryx#751 Add first doxygen docu

Signed-off-by: Christian Eltzschig <me@elchris.org>
ApexAI · May 23, 2022 · 1a7aa4c · 1a7aa4c
1 parent 55b71ba
commit 1a7aa4c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/internal/posix_wrapper/semaphore_interface.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/internal/posix_wrapper/semaphore_interface.hpp
@@ -32,6 +32,7 @@ struct SemaphoreState
     uint32_t numberOfBlockedWait = 0U;
 };
 
+/// @brief Defines the interface of a named and unnamed semaphore.
 template <typename SemaphoreChild>
 class SemaphoreInterface
 {

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/posix_wrapper/unnamed_semaphore.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/posix_wrapper/unnamed_semaphore.hpp
@@ -25,6 +25,7 @@ namespace iox
 {
 namespace posix
 {
+/// @brief A unnamed posix semaphore.
 class UnnamedSemaphore final : public internal::SemaphoreInterface<UnnamedSemaphore>
 {
   public:
@@ -48,7 +49,11 @@ class UnnamedSemaphore final : public internal::SemaphoreInterface<UnnamedSemaph
 
 class UnnamedSemaphoreBuilder
 {
+    /// @brief Set the initial value of the unnamed posix semaphore
     IOX_BUILDER_PARAMETER(uint32_t, initialValue, 0U)
+
+    /// @brief Set if the unnamed semaphore can be stored in the shared memory
+    ///        for inter process usage
     IOX_BUILDER_PARAMETER(bool, isInterProcessCapable, true)
 
   public: