From 1a7aa4cb43351beec3fb30aecebf3bc92fed5561 Mon Sep 17 00:00:00 2001
From: Christian Eltzschig <me@elchris.org>
Date: Mon, 23 May 2022 16:43:03 +0200
Subject: [PATCH] iox-#751 Add first doxygen docu

Signed-off-by: Christian Eltzschig <me@elchris.org>
---
 .../internal/posix_wrapper/semaphore_interface.hpp           | 1 +
 .../iceoryx_hoofs/posix_wrapper/unnamed_semaphore.hpp        | 5 +++++
 2 files changed, 6 insertions(+)

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
index a3e7f9ea59e..4260aa144a8 100644
--- 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
index 3300dd3507c..112d9f308f0 100644
--- 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: