iox-#1594 Extend documentation on ScopeGuard

Signed-off-by: Simon Hoinkis <[email protected]>

Author: mossmaurice-apexai

doc/website/release-notes/iceoryx-unreleased.md

@@ -45,7 +45,7 @@
 - Add "inline" keyword to smart_lock method implementation [\#1551](https://github.com/eclipse-iceoryx/iceoryx/issues/1551)
 - Fix RouDi crash due to uninitialized `ServiceRegistry` chunk [\#1575](https://github.com/eclipse-iceoryx/iceoryx/issues/1575)
 - Add check in `cxx::unique_ptr::get` to avoid `nullptr` dereferencing [\#1571](https://github.com/eclipse-iceoryx/iceoryx/issues/1571)
-- Pass `CleanupCapacity` to underlying `cxx::function` in `ScopeGuard` (formerly know as `cxx::GenericRAII`) [\#1594](https://github.com/eclipse-iceoryx/iceoryx/issues/1594)
+- Pass `CleanupCapacity` to underlying `cxx::function` in `ScopeGuard` (formerly known as `cxx::GenericRAII`) [\#1594](https://github.com/eclipse-iceoryx/iceoryx/issues/1594)
 
 **Refactoring:**
 

iceoryx_hoofs/include/iceoryx_hoofs/cxx/scope_guard.hpp

@@ -28,16 +28,17 @@ namespace cxx
 ///             idiom quickly. You set 2 functions, one which is called in the
 ///             constructor and another function is called in the destructor
 ///             which can be useful when handling resources.
+/// @tparam [in] CleanupCapacity The static storage capacity available to store a cleanup callable in bytes
 /// @code
 /// // This example leads to a console output of:
 /// // hello world
 /// // I am doing stuff
 /// // goodbye
 /// void someFunc() {
-///     auto raii{[](){ std::cout << "hello world\n"; },
+///     ScopeGuard myScopeGuard{[](){ std::cout << "hello world\n"; },
 ///                 [](){ std::cout << "goodbye\n"; }};
 ///     std::cout << "I am doing stuff\n";
-///     // raii goes out of scope here and the cleanupFunction is called in the
+///     // myScopeGuard goes out of scope here and the cleanupFunction is called in the
 ///     // destructor
 /// }
 /// @endcode