summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2022-05-02 02:19:31 +0200
committerSven Gothel <[email protected]>2022-05-02 02:19:31 +0200
commit76c695c4b8e2fd034d31cdeb54883f759b4df353 (patch)
treedacf07fc8da7cf80e0011843f5ffc8121af42824
parent37f6294f8b4bd9e9ed70e664f600b5f7077afe89 (diff)
Bump v0.9.3; Group {Integral->Integer}, refine group title and list all in READMEv0.9.3
-rw-r--r--README.md20
-rw-r--r--include/jau/basic_types.hpp2
-rw-r--r--include/jau/byte_util.hpp2
-rw-r--r--include/jau/eui48.hpp2
-rw-r--r--include/jau/float_math.hpp4
-rw-r--r--include/jau/fraction_type.hpp4
-rw-r--r--include/jau/function_def.hpp2
-rw-r--r--include/jau/int_math.hpp2
-rw-r--r--include/jau/int_types.hpp7
-rw-r--r--include/jau/java_uplink.hpp2
-rw-r--r--include/jau/ringbuffer.hpp4
11 files changed, 34 insertions, 17 deletions
diff --git a/README.md b/README.md
index b7c3861..d80e45d 100644
--- a/README.md
+++ b/README.md
@@ -13,14 +13,25 @@ This project was extracted from [Direct-BT](https://jausoft.com/cgit/direct_bt.g
## API Documentation
Up to date API documentation can be found:
-* [C++ API Doc](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/index.html)
- - Grouped [C++ Modules](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/modules.html)
+* [C++ API Doc](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/index.html) with [modules](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/modules.html):
+ * [Basic Algorithms](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__Algorithms.html)
+ * [Byte Utilities](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__ByteUtils.html)
+ * [C++ Language Utilities](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__CppLang.html)
+ * [Concurrency](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__Concurrency.html)
+ * [Data Structures](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__DataStructs.html)
+ * [Float types and arithmetic](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__Floats.html)
+ * [Fraction Arithmetic and Time](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__Fractions.html)
+ * [Function Pointer](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__FunctionPtr.html)
+ * [Integer types and arithmetic](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__Integer.html)
+ * [Java VM Utilities](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__JavaVM.html)
+ * [Network Utilities](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__NetUtils.html)
+ * [String Utilities](https://jausoft.com/projects/jaulib/build/documentation/cpp/html/group__StringUtils.html)
* [Java API Doc](https://jausoft.com/projects/jaulib/build/documentation/java/html/index.html).
## Examples
-See *Direct-BT* [C++ API Doc](https://jausoft.com/projects/direct_bt/build/documentation/cpp/html/index.html).
+See *Direct-BT* [C++ API Doc](https://jausoft.com/projects/direct_bt/build/documentation/cpp/html/examples.html).
## Supported Platforms
C++17 and better.
@@ -126,8 +137,9 @@ a Raspi-arm64, Raspi-armhf or PC-amd64 target image.
* First stable release (TODO)
-**0.9.0**
+**0.9.3**
+* Group all functionality in modules: Algorithms, ByteUtils, CppLang, Concurrency, DataStructs, Floats, Fractions, FunctionPtr, Integrals, JavaJVM, NetUtils, StringUtils
* Add getMonotonicTime() & getWallClockTime(), returning fraction_timespec
* Add sleep_for(), sleep_until() and wait_for() & wait_until() using fraction, fraction_timespec, as well as choice over clock type.
* Introduce new types: fraction, fraction_timespec; its constants & literals as well adoption in latch, ringbuffer, service_runner and simple_timer.
diff --git a/include/jau/basic_types.hpp b/include/jau/basic_types.hpp
index df928fa..9da5317 100644
--- a/include/jau/basic_types.hpp
+++ b/include/jau/basic_types.hpp
@@ -217,7 +217,7 @@ namespace jau {
// *************************************************
*/
- /** \addtogroup Integrals
+ /** \addtogroup Integer
*
* @{
*/
diff --git a/include/jau/byte_util.hpp b/include/jau/byte_util.hpp
index 2c6783b..9359100 100644
--- a/include/jau/byte_util.hpp
+++ b/include/jau/byte_util.hpp
@@ -45,6 +45,8 @@ namespace jau {
* Byte utility functions and types for endian- and bit conversions,
* inclusive alignment handling and general get & put functionality.
*
+ * This category is also supporting \ref Integer.
+ *
* All \ref 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.
diff --git a/include/jau/eui48.hpp b/include/jau/eui48.hpp
index 060a154..6932af3 100644
--- a/include/jau/eui48.hpp
+++ b/include/jau/eui48.hpp
@@ -37,7 +37,7 @@
namespace jau {
- /** @defgroup NetUtils Network utilities and types
+ /** @defgroup NetUtils Network Utilities
* Networking types and functionality.
*
* @{
diff --git a/include/jau/float_math.hpp b/include/jau/float_math.hpp
index c410712..ed16868 100644
--- a/include/jau/float_math.hpp
+++ b/include/jau/float_math.hpp
@@ -30,8 +30,8 @@
#include <algorithm>
namespace jau {
- /** @defgroup Floats Float support
- * Float data types and arithmetic
+ /** @defgroup Floats Float types and arithmetic
+ * Float types and arithmetic
* @{
*/
diff --git a/include/jau/fraction_type.hpp b/include/jau/fraction_type.hpp
index d1f9553..f261edd 100644
--- a/include/jau/fraction_type.hpp
+++ b/include/jau/fraction_type.hpp
@@ -46,11 +46,11 @@ namespace jau {
// Remember: constexpr specifier used in a function or static data member (since C++17) declaration implies inline.
- /** @defgroup Fractions Fractions for time and more
+ /** @defgroup Fractions Fraction Arithmetic and Time
* Fraction type and arithmetic support
* inclusive its utilization for time without loss of precision nor range.
*
- * Adds support for \ref Concurrency with general timing functionality
+ * Adds support for \ref Concurrency with general time functionality
* like sleep_until(), sleep_for(), wait_until() and wait_for(),
* completed with getMonotonicTime() and getWallClockTime().
*
diff --git a/include/jau/function_def.hpp b/include/jau/function_def.hpp
index e3ff889..21595c5 100644
--- a/include/jau/function_def.hpp
+++ b/include/jau/function_def.hpp
@@ -37,7 +37,7 @@
namespace jau {
- /** @defgroup FunctionPtr Function pointer support
+ /** @defgroup FunctionPtr Function Pointer
* Function pointer support inclusive capturing lambdas.
*
* @{
diff --git a/include/jau/int_math.hpp b/include/jau/int_math.hpp
index 9355963..a01f512 100644
--- a/include/jau/int_math.hpp
+++ b/include/jau/int_math.hpp
@@ -35,7 +35,7 @@ namespace jau {
#define JAU_USE_BUILDIN_OVERFLOW 1
- /** \addtogroup Integrals
+ /** \addtogroup Integer
*
* @{
*/
diff --git a/include/jau/int_types.hpp b/include/jau/int_types.hpp
index 21984df..c4d2de7 100644
--- a/include/jau/int_types.hpp
+++ b/include/jau/int_types.hpp
@@ -32,8 +32,11 @@
#include <jau/packed_attribute.hpp>
namespace jau {
- /** @defgroup Integrals Integral type support
- * Integral integer data types and arithmetic
+ /** @defgroup Integer Integer types and arithmetic
+ * Integral integer types and arithmetic.
+ *
+ * Further support is coming from \ref ByteUtils.
+ *
* @{
*/
diff --git a/include/jau/java_uplink.hpp b/include/jau/java_uplink.hpp
index 1801ebd..db7c0b1 100644
--- a/include/jau/java_uplink.hpp
+++ b/include/jau/java_uplink.hpp
@@ -33,7 +33,7 @@
namespace jau {
- /** @defgroup JavaVM Java Virtual Machine
+ /** @defgroup JavaVM Java VM Utilities
* Java virtual machine support, helping accessing the JVM and converting data types.
*
* @{
diff --git a/include/jau/ringbuffer.hpp b/include/jau/ringbuffer.hpp
index fac1846..33ce840 100644
--- a/include/jau/ringbuffer.hpp
+++ b/include/jau/ringbuffer.hpp
@@ -56,8 +56,8 @@ namespace jau {
#define _DEBUG_PRINT(...)
#endif
-/** @defgroup DataStructs Data structures and types
- * Data structures and types, notably
+/** @defgroup DataStructs Data Structures
+ * Data structures, notably
* - \ref ringbuffer
* - \ref darray
* - cow_darray