iox-eclipse-iceoryx#1900 Apply reviewer's comments

Signed-off-by: Ziad Mostafa <[email protected]>
zmostafa · Feb 20, 2023 · 9c6ed22 · 9c6ed22
1 parent bd327db
commit 9c6ed22
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 1 deletion.
diff --git a/doc/website/release-notes/iceoryx-unreleased.md b/doc/website/release-notes/iceoryx-unreleased.md
@@ -1022,3 +1022,17 @@
     // after
     #include "iox/duration.hpp"
     ```
+46. Renaming `byte_t` to `byte`
+    `byte` is not a simple type alias, now it is a distinct type like c++17 `std::byte`.
+    The type `byte` does not support any arithmetic operations nor has member functions.
+
+    ```cpp
+    //before
+    using byte_t = uint8_t;
+    iox::byte_t m_size;
+
+    //after
+    enum class byte : uint8_t {};
+    iox::byte m_size;
+    ```
+
diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/iceoryx_hoofs_types.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/iceoryx_hoofs_types.hpp
@@ -26,6 +26,7 @@ namespace iox
 namespace cxx
 {
 /// @deprecated use `iox::byte` instead of `iox::cxx::byte_t`
+using byte_t = byte;
 
 } // namespace cxx
 namespace log

diff --git a/iceoryx_hoofs/vocabulary/include/iox/detail/variant_internal.hpp b/iceoryx_hoofs/vocabulary/include/iox/detail/variant_internal.hpp
@@ -18,7 +18,6 @@
 #define IOX_HOOFS_VOCABULARY_VARIANT_INTERNAL_HPP
 
 #include "iceoryx_hoofs/cxx/requires.hpp"
-#include "iox/iceoryx_hoofs_types.hpp"
 
 #include <cstdint>
 #include <type_traits>

diff --git a/iceoryx_hoofs/vocabulary/include/iox/variant.hpp b/iceoryx_hoofs/vocabulary/include/iox/variant.hpp
@@ -19,6 +19,7 @@
 
 #include "iox/algorithm.hpp"
 #include "iox/detail/variant_internal.hpp"
+#include "iox/iceoryx_hoofs_types.hpp"
 
 #include <cstdint>
 #include <iostream>