Update documentation

eclipse-zenoh · Nov 23, 2023 · f642dd5 · f642dd5
1 parent 968c62e
commit f642dd5
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -316,6 +316,7 @@ Functions
 
 .. autocfunction:: zenoh_commons.h::ze_declare_querying_subscriber
 .. autocfunction:: zenoh_commons.h::ze_undeclare_querying_subscriber
+.. autocfunction:: zenoh_commons.h::ze_querying_subscriber_get
 .. autocfunction:: zenoh_commons.h::ze_querying_subscriber_check
 .. autocfunction:: zenoh_commons.h::ze_querying_subscriber_null
 .. autocfunction:: zenoh_commons.h::ze_querying_subscriber_options_default
diff --git a/include/zenoh_commons.h b/include/zenoh_commons.h
@@ -2094,6 +2094,10 @@ ZENOHC_API struct ze_publication_cache_options_t ze_publication_cache_options_de
  * Returns ``true`` if `sub` is valid.
  */
 ZENOHC_API bool ze_querying_subscriber_check(const struct ze_owned_querying_subscriber_t *sub);
+/**
+ * Make a :c:type:`ze_owned_querying_subscriber_t` to perform an additional query on a specified selector.
+ * The queried samples will be merged with the received publications and made available in the subscriber callback.
+ */
 ZENOHC_API
 int8_t ze_querying_subscriber_get(struct ze_querying_subscriber_t sub,
                                   struct z_keyexpr_t selector,

diff --git a/src/querying_subscriber.rs b/src/querying_subscriber.rs
@@ -228,6 +228,8 @@ pub unsafe extern "C" fn ze_declare_querying_subscriber(
     }
 }
 
+/// Make a :c:type:`ze_owned_querying_subscriber_t` to perform an additional query on a specified selector.
+/// The queried samples will be merged with the received publications and made available in the subscriber callback.
 #[allow(clippy::missing_safety_doc)]
 #[no_mangle]
 pub unsafe extern "C" fn ze_querying_subscriber_get(