diff options
| author | Sven Gothel <[email protected]> | 2022-05-02 01:35:42 +0200 |
|---|---|---|
| committer | Sven Gothel <[email protected]> | 2022-05-02 01:35:42 +0200 |
| commit | 04f1a7248250097f28b4ec3c27edf13f79881104 (patch) | |
| tree | 1ab15a9212bc94ac52b850c40c941a0b639573e1 /include | |
| parent | de9468076e5903fd48df8019085a8859f1825608 (diff) | |
Enhance ByteUtils group API doc
Diffstat (limited to 'include')
| -rw-r--r-- | include/jau/byte_util.hpp | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/include/jau/byte_util.hpp b/include/jau/byte_util.hpp index 0f1bb15..e570bbc 100644 --- a/include/jau/byte_util.hpp +++ b/include/jau/byte_util.hpp @@ -42,9 +42,14 @@ namespace jau { /** @defgroup ByteUtils Byte Utilities - * Byte utility functions and types for endian- and bit conversions, - * inclusive alignment handling and general get & put functionality. + * Byte utility functions and types for endian- and bit conversions, + * inclusive alignment handling and general get & put functionality. * + * All endian API entries are of `constexpr` and hence evaluated at compile time.<br> + * Therefore, if-branches and expressions are also of `constexpr` and optimized 'away' at compile time.<br> + * This includes the `cpu_to_<endian>(..)` and `<endian>_to_cpu(..)` etc utility functions. + * + * See endian enum class regarding endian `constexpr` compile time determination. * @{ */ |