From 4672e5f5eb2be09e565bdea4e142359aa7fc2488 Mon Sep 17 00:00:00 2001
From: Denis Biryukov <denis.biryukov@zettascale.tech>
Date: Wed, 15 Jan 2025 11:16:20 +0100
Subject: [PATCH] clarify docs

---
 include/zenoh_commons.h    | 2 +-
 src/advanced_publisher.rs  | 1 +
 src/advanced_subscriber.rs | 1 -
 3 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/zenoh_commons.h b/include/zenoh_commons.h
index 9c04e91cf..6f3614553 100644
--- a/include/zenoh_commons.h
+++ b/include/zenoh_commons.h
@@ -1059,6 +1059,7 @@ typedef struct ze_advanced_publisher_sample_miss_detection_options_t {
   /**
    * If different from zero, the publisher will send heartbeats with the specified period, which
    * can be used by Advanced Subscribers for missed sample detection (if recovery with zero query period is enabled).
+   * Otherwise, missed samples will be retransmitted based on Advanced Subscribers periodic queries.
    */
   uint64_t heartbeat_period_ms;
 } ze_advanced_publisher_sample_miss_detection_options_t;
@@ -1200,7 +1201,6 @@ typedef struct ze_advanced_subscriber_recovery_options_t {
    * So it is useful for sporadic publications but useless for periodic publications
    * with a period smaller or equal to this period. If set to 0, the missed samples will be retrieved
    * based on publisher's heartbeat.
-   * Retransmission can only be achieved by Publishers that also activate retransmission (and heartbeat if periodic_queries_period_ms is 0).
    */
   uint64_t periodic_queries_period_ms;
 } ze_advanced_subscriber_recovery_options_t;
diff --git a/src/advanced_publisher.rs b/src/advanced_publisher.rs
index fa40978f4..77eec9467 100644
--- a/src/advanced_publisher.rs
+++ b/src/advanced_publisher.rs
@@ -91,6 +91,7 @@ pub struct ze_advanced_publisher_sample_miss_detection_options_t {
     pub is_enabled: bool,
     /// If different from zero, the publisher will send heartbeats with the specified period, which
     /// can be used by Advanced Subscribers for missed sample detection (if recovery with zero query period is enabled).
+    /// Otherwise, missed samples will be retransmitted based on Advanced Subscribers periodic queries.
     pub heartbeat_period_ms: u64,
 }
 
diff --git a/src/advanced_subscriber.rs b/src/advanced_subscriber.rs
index 91edd5ffa..c2728e7d8 100644
--- a/src/advanced_subscriber.rs
+++ b/src/advanced_subscriber.rs
@@ -92,7 +92,6 @@ pub struct ze_advanced_subscriber_recovery_options_t {
     /// So it is useful for sporadic publications but useless for periodic publications
     /// with a period smaller or equal to this period. If set to 0, the missed samples will be retrieved
     /// based on publisher's heartbeat.
-    /// Retransmission can only be achieved by Publishers that also activate retransmission (and heartbeat if periodic_queries_period_ms is 0).
     pub periodic_queries_period_ms: u64,
 }