iox-#1533 Fix typos and clarify documentation

eclipse-iceoryx · Sep 21, 2023 · dd72966 · dd72966
1 parent ac7eb74
commit dd72966
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/doc/website/release-notes/iceoryx-unreleased.md b/doc/website/release-notes/iceoryx-unreleased.md
@@ -1193,7 +1193,7 @@
 
     // after
     #include "iceoryx_posh/roudi_env/roudi_environment.hpp"
-    iox::roudi_enf::RouDiEnv roudiEnv{/*config*/};
+    iox::roudi_env::RouDiEnv roudiEnv{/*config*/};
 
 
     // before
@@ -1204,10 +1204,10 @@
 
 
     // before
-    SetInterOpWaitingTime(/*chrono*/);
+    roudiEnv.SetInterOpWaitingTime(/*chrono*/);
 
     // after
-    setDiscoveryLoopWaitToFinishTimeout(/*units::Duration*/);
+    roudiEnv.setDiscoveryLoopWaitToFinishTimeout(/*units::Duration*/);
 
     ```
 

diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/unique_port_id.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/unique_port_id.hpp
@@ -82,7 +82,7 @@ class UniquePortId : public NewType<UniquePortId,
     friend class roudi_env::RouDiEnv;
     // since the RouDiEnv gets restarted multiple times within a process, this helps to
     // reset the unique RouDi id during tests
-    static void rouDiEnvOverideUniqueRouDiId(const uint16_t id) noexcept;
+    static void rouDiEnvOverrideUniqueRouDiId(const uint16_t id) noexcept;
 
     // returns true if setUniqueRouDiId was already called or a non-invalid UniquePortId
     // was created, otherwise false

diff --git a/iceoryx_posh/roudi_env/source/roudi_env.cpp b/iceoryx_posh/roudi_env/source/roudi_env.cpp
@@ -29,7 +29,7 @@ namespace roudi_env
 {
 RouDiEnv::RouDiEnv(MainCTor, const uint16_t uniqueRouDiId) noexcept
 {
-    popo::UniquePortId::rouDiEnvOverideUniqueRouDiId(uniqueRouDiId);
+    popo::UniquePortId::rouDiEnvOverrideUniqueRouDiId(uniqueRouDiId);
 }
 
 RouDiEnv::RouDiEnv(const RouDiConfig_t& roudiConfig,
@@ -48,7 +48,7 @@ RouDiEnv::~RouDiEnv() noexcept
 {
     if (m_runtimes.m_doCleanupOnDestruction)
     {
-        popo::UniquePortId::rouDiEnvOverideUniqueRouDiId(roudi::DEFAULT_UNIQUE_ROUDI_ID);
+        popo::UniquePortId::rouDiEnvOverrideUniqueRouDiId(roudi::DEFAULT_UNIQUE_ROUDI_ID);
     }
     cleanupRuntimes();
 }

diff --git a/iceoryx_posh/source/popo/building_blocks/unique_port_id.cpp b/iceoryx_posh/source/popo/building_blocks/unique_port_id.cpp
@@ -63,7 +63,7 @@ void UniquePortId::setUniqueRouDiId(const uint16_t id) noexcept
     uniqueRouDiId.store(id, std::memory_order_relaxed);
 }
 
-void UniquePortId::rouDiEnvOverideUniqueRouDiId(const uint16_t id) noexcept
+void UniquePortId::rouDiEnvOverrideUniqueRouDiId(const uint16_t id) noexcept
 {
     uniqueRouDiId.store(id, std::memory_order_relaxed);
 }