diff --git a/iceoryx_dust/README.md b/iceoryx_dust/README.md index 50f4759700..ae216b274a 100644 --- a/iceoryx_dust/README.md +++ b/iceoryx_dust/README.md @@ -7,15 +7,15 @@ Compared to hoofs classes in `iceoryx_dust`, the difference is that the classes There are a wide variety of building blocks grouped together in categories or namespace, depending on where or how they are used. -| class/file | description | -|:---------------------:|:------------------------------------------------------------------------------------------------------------------------| -|`forward_list` | Heap and exception free, relocatable implementation of `std::forward_list` | -|`ObjectPool` | Container which stores raw objects without calling the ctor of the objects. | -|`FileReader` | Wrapper for opening files and reading them. | -|`MessageQueue` | Interface for Message Queues, see [ManPage mq_overview](https://www.man7.org/linux/man-pages/man7/mq_overview.7.html). | -|`SignalWatcher` | Batteries included signal handling with polling and optional blocking wait for `SIGINT` and `SIGTERM`. | -|`NamedPipe` | Shared memory based ipc channel. Mainly a `UnixDomainSocket` replacement on Windows. | -|`relocatable_ptr` | | -|`static_storage` | Untyped aligned static storage. | -|`convert` | | Converting a number into a string is easy, converting it back can be hard. You can use functions like `strtoll` but you still have to handle errors like under- and overflow, or converting invalid strings into number. Here we abstract all the error handling so that you can convert strings into numbers safely. | -|`serialization` | | Implements a simple serialization concept for classes based on the idea presented here [ISOCPP serialization](https://isocpp.org/wiki/faq/serialization#serialize-text-format). | +| class/file | description | +|:---------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|`forward_list` | Heap and exception free, relocatable implementation of `std::forward_list` | +|`ObjectPool` | Container which stores raw objects without calling the ctor of the objects. | +|`FileReader` | Wrapper for opening files and reading them. | +|`MessageQueue` | Interface for Message Queues, see [ManPage mq_overview](https://www.man7.org/linux/man-pages/man7/mq_overview.7.html). | +|`SignalWatcher` | Batteries included signal handling with polling and optional blocking wait for `SIGINT` and `SIGTERM`. | +|`NamedPipe` | Shared memory based ipc channel. Mainly a `UnixDomainSocket` replacement on Windows. | +|`relocatable_ptr` | | +|`static_storage` | Untyped aligned static storage. | +|`convert` | Converting a number into a string is easy, converting it back can be hard. You can use functions like `strtoll` but you still have to handle errors like under- and overflow, or converting invalid strings into number. Here we abstract all the error handling so that you can convert strings into numbers safely. | +|`serialization` | Implements a simple serialization concept for classes based on the idea presented here [ISOCPP serialization](https://isocpp.org/wiki/faq/serialization#serialize-text-format). | diff --git a/iceoryx_hoofs/README.md b/iceoryx_hoofs/README.md index da3118ee92..140846d106 100644 --- a/iceoryx_hoofs/README.md +++ b/iceoryx_hoofs/README.md @@ -73,9 +73,11 @@ The module structure is a logical grouping. It is replicated for `concurrent` an | class | internal | description | |:---------------------:|:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -|`helplets` | | Implementations of [C++ Core Guideline](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) concepts like `not_null` are contained here. Additionally, we are providing some types to verify preconditions at compile time. | | -|`system_configuration` | i | Collection of free functions which acquire system information like the page-size. | -|`UniqueId` | i | Monotonic increasing IDs within a process. | +|`helplets` | | Implementations of [C++ Core Guideline](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) concepts like `not_null` are contained here. Additionally, we are providing some types to verify preconditions at compile time. | +|`system_configuration` | i | Collection of free functions which acquire system information like the page-size. | +|`UniqueId` | i | Monotonic increasing IDs within a process. | +|`into` | i | | +|`pageSize` | i | | ### Primitives (primitives) diff --git a/tools/scripts/used-headers.txt b/tools/scripts/used-headers.txt index 4f5d7c4adc..474199c8ef 100644 --- a/tools/scripts/used-headers.txt +++ b/tools/scripts/used-headers.txt @@ -30,7 +30,6 @@ atomic bitset cassert chrono -climits cmath cpptoml.h csignal