From ca532440777e99ee9cf2f55cf6dcef3d9f6bdcb7 Mon Sep 17 00:00:00 2001 From: Joseph Perez Date: Thu, 17 Jul 2025 11:01:09 +0200 Subject: [PATCH 1/6] add CongestionControl::BlockFirst documentation --- include/zenoh/api/enums.hxx | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/include/zenoh/api/enums.hxx b/include/zenoh/api/enums.hxx index a18cd787..52bcf6fd 100644 --- a/include/zenoh/api/enums.hxx +++ b/include/zenoh/api/enums.hxx @@ -55,6 +55,7 @@ typedef ::z_consolidation_mode_t ConsolidationMode; typedef ::z_reliability_t Reliability; #endif +#if defined(ZENOHCXX_ZENOHC) && defined(Z_FEATURE_UNSTABLE_API) /// Congestion control values. /// /// Values: @@ -62,8 +63,21 @@ typedef ::z_reliability_t Reliability; /// congestion control /// - **Z_CONGESTION_CONTROL_DROP**: Defines congestion control as "drop". Messages are dropped in case of /// congestion control +/// - **Z_CONGESTION_CONTROL_BLOCK_FIRST**: Defines congestion control as "block first". Messages except the first +/// one are dropped in case of congestion control /// typedef ::z_congestion_control_t CongestionControl; +#else +/// Congestion control values. +/// +/// Values: +/// - **Z_CONGESTION_CONTROL_BLOCK**: Defines congestion control as "block". Messages are not dropped in case of +/// congestion control +/// - **Z_CONGESTION_CONTROL_DROP**: Defines congestion control as "drop". Messages are dropped in case of +/// congestion control +/// +typedef ::z_congestion_control_t CongestionControl; +#endif /// Priority of Zenoh messages values. /// From 8a0d18e7dc31b63c41dde2e1b2b611e935899070 Mon Sep 17 00:00:00 2001 From: Joseph Perez Date: Thu, 17 Jul 2025 11:09:30 +0200 Subject: [PATCH 2/6] please Denis --- include/zenoh/api/enums.hxx | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/include/zenoh/api/enums.hxx b/include/zenoh/api/enums.hxx index 52bcf6fd..76a8442e 100644 --- a/include/zenoh/api/enums.hxx +++ b/include/zenoh/api/enums.hxx @@ -55,7 +55,6 @@ typedef ::z_consolidation_mode_t ConsolidationMode; typedef ::z_reliability_t Reliability; #endif -#if defined(ZENOHCXX_ZENOHC) && defined(Z_FEATURE_UNSTABLE_API) /// Congestion control values. /// /// Values: @@ -65,19 +64,11 @@ typedef ::z_reliability_t Reliability; /// congestion control /// - **Z_CONGESTION_CONTROL_BLOCK_FIRST**: Defines congestion control as "block first". Messages except the first /// one are dropped in case of congestion control +/// @warning This API has been marked as unstable: it works as advertised, but it may be changed in a future +/// release. +/// @note Zenoh-c only. /// typedef ::z_congestion_control_t CongestionControl; -#else -/// Congestion control values. -/// -/// Values: -/// - **Z_CONGESTION_CONTROL_BLOCK**: Defines congestion control as "block". Messages are not dropped in case of -/// congestion control -/// - **Z_CONGESTION_CONTROL_DROP**: Defines congestion control as "drop". Messages are dropped in case of -/// congestion control -/// -typedef ::z_congestion_control_t CongestionControl; -#endif /// Priority of Zenoh messages values. /// From 2bf62099362aee11283180fa1107500b5e950cb9 Mon Sep 17 00:00:00 2001 From: Joseph Perez Date: Thu, 17 Jul 2025 11:11:49 +0200 Subject: [PATCH 3/6] fix doc --- include/zenoh/api/enums.hxx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/include/zenoh/api/enums.hxx b/include/zenoh/api/enums.hxx index 76a8442e..6a42c110 100644 --- a/include/zenoh/api/enums.hxx +++ b/include/zenoh/api/enums.hxx @@ -61,12 +61,12 @@ typedef ::z_reliability_t Reliability; /// - **Z_CONGESTION_CONTROL_BLOCK**: Defines congestion control as "block". Messages are not dropped in case of /// congestion control /// - **Z_CONGESTION_CONTROL_DROP**: Defines congestion control as "drop". Messages are dropped in case of -/// congestion control +/// congestion control /// - **Z_CONGESTION_CONTROL_BLOCK_FIRST**: Defines congestion control as "block first". Messages except the first -/// one are dropped in case of congestion control -/// @warning This API has been marked as unstable: it works as advertised, but it may be changed in a future -/// release. -/// @note Zenoh-c only. +/// one are dropped in case of congestion control +/// @warning This API has been marked as unstable: it works as advertised, but it may be changed in a future +/// release. +/// @note Zenoh-c only. /// typedef ::z_congestion_control_t CongestionControl; From 0f79496d7d6aa8985632929f65eaa4ebd389143e Mon Sep 17 00:00:00 2001 From: Joseph Perez Date: Thu, 17 Jul 2025 11:21:07 +0200 Subject: [PATCH 4/6] fix doc --- include/zenoh/api/enums.hxx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/include/zenoh/api/enums.hxx b/include/zenoh/api/enums.hxx index 6a42c110..4734099e 100644 --- a/include/zenoh/api/enums.hxx +++ b/include/zenoh/api/enums.hxx @@ -64,9 +64,9 @@ typedef ::z_reliability_t Reliability; /// congestion control /// - **Z_CONGESTION_CONTROL_BLOCK_FIRST**: Defines congestion control as "block first". Messages except the first /// one are dropped in case of congestion control -/// @warning This API has been marked as unstable: it works as advertised, but it may be changed in a future +/// @warning **Z_CONGESTION_CONTROL_BLOCK_FIRST** has been marked as unstable: it works as advertised, but it may be changed in a future /// release. -/// @note Zenoh-c only. +/// @note **Z_CONGESTION_CONTROL_BLOCK_FIRST** is Zenoh-c only. /// typedef ::z_congestion_control_t CongestionControl; From 30cea3cd9e310241fc9f50fe131c0f3e5bfa3477 Mon Sep 17 00:00:00 2001 From: Joseph Perez Date: Thu, 17 Jul 2025 11:27:47 +0200 Subject: [PATCH 5/6] fix doc --- include/zenoh/api/enums.hxx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/include/zenoh/api/enums.hxx b/include/zenoh/api/enums.hxx index 4734099e..55fe6a5b 100644 --- a/include/zenoh/api/enums.hxx +++ b/include/zenoh/api/enums.hxx @@ -57,16 +57,16 @@ typedef ::z_reliability_t Reliability; /// Congestion control values. /// -/// Values: +/// Values: /// - **Z_CONGESTION_CONTROL_BLOCK**: Defines congestion control as "block". Messages are not dropped in case of /// congestion control /// - **Z_CONGESTION_CONTROL_DROP**: Defines congestion control as "drop". Messages are dropped in case of /// congestion control /// - **Z_CONGESTION_CONTROL_BLOCK_FIRST**: Defines congestion control as "block first". Messages except the first /// one are dropped in case of congestion control -/// @warning **Z_CONGESTION_CONTROL_BLOCK_FIRST** has been marked as unstable: it works as advertised, but it may be changed in a future +/// @warning **Z_CONGESTION_CONTROL_BLOCK_FIRST** has been marked as unstable: it works as advertised, but it may be changed in a future /// release. -/// @note **Z_CONGESTION_CONTROL_BLOCK_FIRST** is Zenoh-c only. +/// @note **Z_CONGESTION_CONTROL_BLOCK_FIRST** is Zenoh-c only. /// typedef ::z_congestion_control_t CongestionControl; From c8f2bfe4aeb2c91a5ff15755df35ea78a88560d0 Mon Sep 17 00:00:00 2001 From: Joseph Perez Date: Wed, 23 Jul 2025 10:23:39 +0200 Subject: [PATCH 6/6] fix format --- include/zenoh/api/enums.hxx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/include/zenoh/api/enums.hxx b/include/zenoh/api/enums.hxx index 55fe6a5b..e5977ebf 100644 --- a/include/zenoh/api/enums.hxx +++ b/include/zenoh/api/enums.hxx @@ -64,8 +64,8 @@ typedef ::z_reliability_t Reliability; /// congestion control /// - **Z_CONGESTION_CONTROL_BLOCK_FIRST**: Defines congestion control as "block first". Messages except the first /// one are dropped in case of congestion control -/// @warning **Z_CONGESTION_CONTROL_BLOCK_FIRST** has been marked as unstable: it works as advertised, but it may be changed in a future -/// release. +/// @warning **Z_CONGESTION_CONTROL_BLOCK_FIRST** has been marked as unstable: it works as advertised, but it may be +/// changed in a future release. /// @note **Z_CONGESTION_CONTROL_BLOCK_FIRST** is Zenoh-c only. /// typedef ::z_congestion_control_t CongestionControl;