From 25577643e1f42992cff00b1687c37c22c63a263c Mon Sep 17 00:00:00 2001 From: OlivierHecart Date: Thu, 19 Sep 2024 19:16:16 +0200 Subject: [PATCH] Dev/rustdoc (#1453) * Add unstable warning to zenoh-plugin-trait rustdoc * Improve unstable warning * Improve rustdoc * Fix clippy * Add README for internal crates (#1451) * Remove style in unstable warning message * Dev/rustdoc (#1455) * Add README for internal crates * add hardlinks for internal crate README, fix Type References in docs, workaround with `zenoh_macros::unstable` causing cargo doc to fail refeneces * Restore single line summary behaviour * fmt * remove zenoh::prelude from Locality doc * Add warning to shm module and crate doc * Add internal warning to zenoh-config zenoh-keyexpr and zenoh-runtime crates doc --------- Co-authored-by: Luca Cominardi Co-authored-by: Charles Schleich --- commons/zenoh-buffers/src/lib.rs | 2 +- commons/zenoh-codec/src/lib.rs | 2 +- commons/zenoh-collections/src/lib.rs | 2 +- commons/zenoh-config/src/lib.rs | 6 ++++++ commons/zenoh-core/src/lib.rs | 2 +- commons/zenoh-crypto/src/lib.rs | 2 +- commons/zenoh-keyexpr/src/lib.rs | 6 ++++++ commons/zenoh-macros/src/lib.rs | 20 ++++++++++++++----- .../zenoh-macros/src/zenoh_runtime_derive.rs | 2 +- commons/zenoh-protocol/src/lib.rs | 2 +- commons/zenoh-result/src/lib.rs | 2 +- commons/zenoh-runtime/README.md | 8 ++++++++ commons/zenoh-runtime/src/lib.rs | 6 ++++++ commons/zenoh-shm/src/lib.rs | 6 ++++++ commons/zenoh-sync/src/lib.rs | 2 +- commons/zenoh-task/README.md | 8 ++++++++ commons/zenoh-task/src/lib.rs | 2 +- commons/zenoh-util/src/lib.rs | 2 +- commons/zenoh-util/src/log.rs | 12 +++++++---- io/zenoh-link-commons/src/lib.rs | 2 +- io/zenoh-link/src/lib.rs | 2 +- io/zenoh-links/zenoh-link-quic/README.md | 8 ++++++++ io/zenoh-links/zenoh-link-quic/src/lib.rs | 2 +- io/zenoh-links/zenoh-link-serial/README.md | 8 ++++++++ io/zenoh-links/zenoh-link-serial/src/lib.rs | 2 +- io/zenoh-links/zenoh-link-tcp/README.md | 8 ++++++++ io/zenoh-links/zenoh-link-tcp/src/lib.rs | 2 +- io/zenoh-links/zenoh-link-tls/README.md | 8 ++++++++ io/zenoh-links/zenoh-link-tls/src/lib.rs | 2 +- io/zenoh-links/zenoh-link-udp/README.md | 8 ++++++++ io/zenoh-links/zenoh-link-udp/src/lib.rs | 2 +- io/zenoh-links/zenoh-link-unixpipe/README.md | 8 ++++++++ io/zenoh-links/zenoh-link-unixpipe/src/lib.rs | 2 +- .../zenoh-link-unixpipe/src/unix/mod.rs | 2 +- .../zenoh-link-unixsock_stream/README.md | 8 ++++++++ .../zenoh-link-unixsock_stream/src/lib.rs | 2 +- io/zenoh-links/zenoh-link-vsock/README.md | 8 ++++++++ io/zenoh-links/zenoh-link-vsock/src/lib.rs | 2 +- io/zenoh-links/zenoh-link-ws/README.md | 8 ++++++++ io/zenoh-links/zenoh-link-ws/src/lib.rs | 2 +- io/zenoh-transport/src/lib.rs | 2 +- plugins/zenoh-plugin-rest/src/lib.rs | 2 +- .../zenoh-plugin-storage-manager/src/lib.rs | 2 +- plugins/zenoh-plugin-trait/src/lib.rs | 2 ++ zenoh-ext/README.md | 8 ++++++++ zenoh-ext/src/querying_subscriber.rs | 6 ++++-- zenoh/src/api/builders/publisher.rs | 8 ++++++-- zenoh/src/api/liveliness.rs | 13 ++++++------ zenoh/src/api/publisher.rs | 2 +- zenoh/src/api/query.rs | 6 +++++- zenoh/src/api/queryable.rs | 4 +++- zenoh/src/api/session.rs | 2 +- zenoh/src/api/subscriber.rs | 2 +- zenoh/src/lib.rs | 1 + zenoh/src/net/mod.rs | 2 +- zenoh/src/net/routing/dispatcher/mod.rs | 2 +- zenoh/src/net/routing/hat/client/mod.rs | 2 +- .../src/net/routing/hat/linkstate_peer/mod.rs | 2 +- zenoh/src/net/routing/hat/mod.rs | 2 +- zenoh/src/net/routing/hat/p2p_peer/mod.rs | 2 +- zenoh/src/net/routing/hat/router/mod.rs | 2 +- .../net/routing/interceptor/access_control.rs | 2 +- .../net/routing/interceptor/authorization.rs | 2 +- .../net/routing/interceptor/downsampling.rs | 2 +- zenoh/src/net/routing/interceptor/mod.rs | 2 +- zenoh/src/net/routing/mod.rs | 2 +- zenoh/src/net/runtime/mod.rs | 2 +- 67 files changed, 212 insertions(+), 64 deletions(-) create mode 100644 commons/zenoh-runtime/README.md create mode 100644 commons/zenoh-task/README.md create mode 100644 io/zenoh-links/zenoh-link-quic/README.md create mode 100644 io/zenoh-links/zenoh-link-serial/README.md create mode 100644 io/zenoh-links/zenoh-link-tcp/README.md create mode 100644 io/zenoh-links/zenoh-link-tls/README.md create mode 100644 io/zenoh-links/zenoh-link-udp/README.md create mode 100644 io/zenoh-links/zenoh-link-unixpipe/README.md create mode 100644 io/zenoh-links/zenoh-link-unixsock_stream/README.md create mode 100644 io/zenoh-links/zenoh-link-vsock/README.md create mode 100644 io/zenoh-links/zenoh-link-ws/README.md create mode 100644 zenoh-ext/README.md diff --git a/commons/zenoh-buffers/src/lib.rs b/commons/zenoh-buffers/src/lib.rs index ee630b4201..1024958892 100644 --- a/commons/zenoh-buffers/src/lib.rs +++ b/commons/zenoh-buffers/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) //! //! Provide different buffer implementations used for serialization and deserialization. #![cfg_attr(not(feature = "std"), no_std)] diff --git a/commons/zenoh-codec/src/lib.rs b/commons/zenoh-codec/src/lib.rs index 9e0193f9e2..86bac15304 100644 --- a/commons/zenoh-codec/src/lib.rs +++ b/commons/zenoh-codec/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) #![cfg_attr(not(feature = "std"), no_std)] extern crate alloc; diff --git a/commons/zenoh-collections/src/lib.rs b/commons/zenoh-collections/src/lib.rs index 6549594de2..f19c10ad25 100644 --- a/commons/zenoh-collections/src/lib.rs +++ b/commons/zenoh-collections/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) #![cfg_attr(not(feature = "std"), no_std)] extern crate alloc; diff --git a/commons/zenoh-config/src/lib.rs b/commons/zenoh-config/src/lib.rs index fcda6e951a..9bc30dfcde 100644 --- a/commons/zenoh-config/src/lib.rs +++ b/commons/zenoh-config/src/lib.rs @@ -12,6 +12,12 @@ // ZettaScale Zenoh Team, // +//! ⚠️ WARNING ⚠️ +//! +//! This crate is intended for Zenoh's internal use. +//! +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) +//! //! Configuration to pass to `zenoh::open()` and `zenoh::scout()` functions and associated constants. pub mod defaults; mod include; diff --git a/commons/zenoh-core/src/lib.rs b/commons/zenoh-core/src/lib.rs index 719f3bedd1..3e218dbdc3 100644 --- a/commons/zenoh-core/src/lib.rs +++ b/commons/zenoh-core/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) pub use lazy_static::lazy_static; pub mod macros; diff --git a/commons/zenoh-crypto/src/lib.rs b/commons/zenoh-crypto/src/lib.rs index f65cdb27bb..42c6e7a789 100644 --- a/commons/zenoh-crypto/src/lib.rs +++ b/commons/zenoh-crypto/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) mod cipher; pub mod hmac; mod prng; diff --git a/commons/zenoh-keyexpr/src/lib.rs b/commons/zenoh-keyexpr/src/lib.rs index 03565fe63a..1ab5a79762 100644 --- a/commons/zenoh-keyexpr/src/lib.rs +++ b/commons/zenoh-keyexpr/src/lib.rs @@ -12,6 +12,12 @@ // ZettaScale Zenoh Team, // +//! ⚠️ WARNING ⚠️ +//! +//! This crate is intended for Zenoh's internal use. +//! +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) +//! //! [Key expression](https://github.com/eclipse-zenoh/roadmap/blob/main/rfcs/ALL/Key%20Expressions.md) are Zenoh's address space. //! //! In Zenoh, operations are performed on keys. To allow addressing multiple keys with a single operation, we use Key Expressions (KE). diff --git a/commons/zenoh-macros/src/lib.rs b/commons/zenoh-macros/src/lib.rs index 97a81b9e0f..2047c424cf 100644 --- a/commons/zenoh-macros/src/lib.rs +++ b/commons/zenoh-macros/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use proc_macro::TokenStream; use quote::{quote, ToTokens}; use syn::{parse_macro_input, parse_quote, Attribute, Error, Item, ItemImpl, LitStr, TraitItem}; @@ -152,10 +152,20 @@ pub fn unstable_doc(_attr: TokenStream, tokens: TokenStream) -> TokenStream { }; if attrs.iter().any(is_doc_attribute) { - // See: https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#adding-a-warning-block - let message = "
This API has been marked as unstable: it works as advertised, but it may be changed in a future release.
"; - let note: Attribute = parse_quote!(#[doc = #message]); - attrs.push(note); + let mut pushed = false; + let oldattrs = std::mem::take(attrs); + for attr in oldattrs { + if is_doc_attribute(&attr) && !pushed { + attrs.push(attr); + // See: https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#adding-a-warning-block + let message = "
This API has been marked as unstable: it works as advertised, but it may be changed in a future release.
"; + let note: Attribute = parse_quote!(#[doc = #message]); + attrs.push(note); + pushed = true; + } else { + attrs.push(attr); + } + } } TokenStream::from(item.to_token_stream()) diff --git a/commons/zenoh-macros/src/zenoh_runtime_derive.rs b/commons/zenoh-macros/src/zenoh_runtime_derive.rs index c08844481c..f6ec4a8145 100644 --- a/commons/zenoh-macros/src/zenoh_runtime_derive.rs +++ b/commons/zenoh-macros/src/zenoh_runtime_derive.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use proc_macro2::TokenStream; use quote::{format_ident, quote, ToTokens}; use syn::{ diff --git a/commons/zenoh-protocol/src/lib.rs b/commons/zenoh-protocol/src/lib.rs index fbfefa7c09..a26b489dbf 100644 --- a/commons/zenoh-protocol/src/lib.rs +++ b/commons/zenoh-protocol/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) #![cfg_attr(not(feature = "std"), no_std)] extern crate alloc; diff --git a/commons/zenoh-result/src/lib.rs b/commons/zenoh-result/src/lib.rs index 79de74f4eb..ae295fd1d7 100644 --- a/commons/zenoh-result/src/lib.rs +++ b/commons/zenoh-result/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) #![cfg_attr(not(feature = "std"), no_std)] extern crate alloc; diff --git a/commons/zenoh-runtime/README.md b/commons/zenoh-runtime/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/commons/zenoh-runtime/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/commons/zenoh-runtime/src/lib.rs b/commons/zenoh-runtime/src/lib.rs index c0e1bec2ef..e1a8652507 100644 --- a/commons/zenoh-runtime/src/lib.rs +++ b/commons/zenoh-runtime/src/lib.rs @@ -11,6 +11,12 @@ // Contributors: // ZettaScale Zenoh Team, // + +//! ⚠️ WARNING ⚠️ +//! +//! This crate is intended for Zenoh's internal use. +//! +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use core::panic; use std::{ borrow::Borrow, diff --git a/commons/zenoh-shm/src/lib.rs b/commons/zenoh-shm/src/lib.rs index 2d8173c2f9..20fec9c204 100644 --- a/commons/zenoh-shm/src/lib.rs +++ b/commons/zenoh-shm/src/lib.rs @@ -11,6 +11,12 @@ // Contributors: // ZettaScale Zenoh Team, // + +//! ⚠️ WARNING ⚠️ +//! +//! This crate is intended for Zenoh's internal use. +//! +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::{ any::Any, num::NonZeroUsize, diff --git a/commons/zenoh-sync/src/lib.rs b/commons/zenoh-sync/src/lib.rs index 8289b29fbb..3c213fd4f9 100644 --- a/commons/zenoh-sync/src/lib.rs +++ b/commons/zenoh-sync/src/lib.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::{ future::Future, pin::Pin, diff --git a/commons/zenoh-task/README.md b/commons/zenoh-task/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/commons/zenoh-task/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/commons/zenoh-task/src/lib.rs b/commons/zenoh-task/src/lib.rs index 2a06b56b5c..9c863da4f4 100644 --- a/commons/zenoh-task/src/lib.rs +++ b/commons/zenoh-task/src/lib.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::{future::Future, time::Duration}; diff --git a/commons/zenoh-util/src/lib.rs b/commons/zenoh-util/src/lib.rs index a6cf03e5fb..0ec07fce6b 100644 --- a/commons/zenoh-util/src/lib.rs +++ b/commons/zenoh-util/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use lazy_static::lazy_static; pub mod ffi; diff --git a/commons/zenoh-util/src/log.rs b/commons/zenoh-util/src/log.rs index 023c77121f..fb77b2e9f6 100644 --- a/commons/zenoh-util/src/log.rs +++ b/commons/zenoh-util/src/log.rs @@ -20,8 +20,10 @@ use tracing_subscriber::{ EnvFilter, }; -/// This is a utility function to enable the tracing formatting subscriber from -/// the `RUST_LOG` environment variable. If `RUST_LOG` is not set, then logging is not enabled. +/// A utility function to enable the tracing formatting subscriber. +/// +/// The tracing formatting subscriber is initialized from the `RUST_LOG` environment variable. +/// If `RUST_LOG` is not set, then logging is not enabled. /// /// # Safety /// Calling this function initializes a `lazy_static` in the `tracing` crate @@ -34,8 +36,10 @@ pub fn try_init_log_from_env() { } } -/// This is a utility function to enable the tracing formatting subscriber from -/// the environment variable. If `RUST_LOG` is not set, then fallback directives are used. +/// A utility function to enable the tracing formatting subscriber. +/// +/// The tracing formatting subscriber is initialized from the `RUST_LOG` environment variable. +/// If `RUST_LOG` is not set, then fallback directives are used. /// /// # Safety /// Calling this function initializes a `lazy_static` in the `tracing` crate diff --git a/io/zenoh-link-commons/src/lib.rs b/io/zenoh-link-commons/src/lib.rs index 46c0968f3f..9ecf1a0dfc 100644 --- a/io/zenoh-link-commons/src/lib.rs +++ b/io/zenoh-link-commons/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) extern crate alloc; mod listener; diff --git a/io/zenoh-link/src/lib.rs b/io/zenoh-link/src/lib.rs index 7898cf087d..64f5caa4b8 100644 --- a/io/zenoh-link/src/lib.rs +++ b/io/zenoh-link/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::collections::HashMap; use zenoh_config::Config; diff --git a/io/zenoh-links/zenoh-link-quic/README.md b/io/zenoh-links/zenoh-link-quic/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/io/zenoh-links/zenoh-link-quic/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/io/zenoh-links/zenoh-link-quic/src/lib.rs b/io/zenoh-links/zenoh-link-quic/src/lib.rs index cde9c589a3..2093aec735 100644 --- a/io/zenoh-links/zenoh-link-quic/src/lib.rs +++ b/io/zenoh-links/zenoh-link-quic/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use async_trait::async_trait; use zenoh_core::zconfigurable; use zenoh_link_commons::LocatorInspector; diff --git a/io/zenoh-links/zenoh-link-serial/README.md b/io/zenoh-links/zenoh-link-serial/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/io/zenoh-links/zenoh-link-serial/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/io/zenoh-links/zenoh-link-serial/src/lib.rs b/io/zenoh-links/zenoh-link-serial/src/lib.rs index 3d2ddcd0e6..ddf37aa1cf 100644 --- a/io/zenoh-links/zenoh-link-serial/src/lib.rs +++ b/io/zenoh-links/zenoh-link-serial/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) mod unicast; use std::str::FromStr; diff --git a/io/zenoh-links/zenoh-link-tcp/README.md b/io/zenoh-links/zenoh-link-tcp/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/io/zenoh-links/zenoh-link-tcp/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/io/zenoh-links/zenoh-link-tcp/src/lib.rs b/io/zenoh-links/zenoh-link-tcp/src/lib.rs index ebc2bba70b..aab70c53af 100644 --- a/io/zenoh-links/zenoh-link-tcp/src/lib.rs +++ b/io/zenoh-links/zenoh-link-tcp/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::net::SocketAddr; use async_trait::async_trait; diff --git a/io/zenoh-links/zenoh-link-tls/README.md b/io/zenoh-links/zenoh-link-tls/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/io/zenoh-links/zenoh-link-tls/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/io/zenoh-links/zenoh-link-tls/src/lib.rs b/io/zenoh-links/zenoh-link-tls/src/lib.rs index 9fe6a3ea14..357f6d4248 100644 --- a/io/zenoh-links/zenoh-link-tls/src/lib.rs +++ b/io/zenoh-links/zenoh-link-tls/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use async_trait::async_trait; use zenoh_core::zconfigurable; use zenoh_link_commons::LocatorInspector; diff --git a/io/zenoh-links/zenoh-link-udp/README.md b/io/zenoh-links/zenoh-link-udp/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/io/zenoh-links/zenoh-link-udp/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/io/zenoh-links/zenoh-link-udp/src/lib.rs b/io/zenoh-links/zenoh-link-udp/src/lib.rs index 3386ca387c..6ba0b8309e 100644 --- a/io/zenoh-links/zenoh-link-udp/src/lib.rs +++ b/io/zenoh-links/zenoh-link-udp/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) mod multicast; mod unicast; diff --git a/io/zenoh-links/zenoh-link-unixpipe/README.md b/io/zenoh-links/zenoh-link-unixpipe/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/io/zenoh-links/zenoh-link-unixpipe/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/io/zenoh-links/zenoh-link-unixpipe/src/lib.rs b/io/zenoh-links/zenoh-link-unixpipe/src/lib.rs index 96e373a66d..a7b0a92049 100644 --- a/io/zenoh-links/zenoh-link-unixpipe/src/lib.rs +++ b/io/zenoh-links/zenoh-link-unixpipe/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) #[cfg(unix)] mod unix; diff --git a/io/zenoh-links/zenoh-link-unixpipe/src/unix/mod.rs b/io/zenoh-links/zenoh-link-unixpipe/src/unix/mod.rs index ff1c2f983b..7e2d03717d 100644 --- a/io/zenoh-links/zenoh-link-unixpipe/src/unix/mod.rs +++ b/io/zenoh-links/zenoh-link-unixpipe/src/unix/mod.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) pub mod unicast; use async_trait::async_trait; diff --git a/io/zenoh-links/zenoh-link-unixsock_stream/README.md b/io/zenoh-links/zenoh-link-unixsock_stream/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/io/zenoh-links/zenoh-link-unixsock_stream/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/io/zenoh-links/zenoh-link-unixsock_stream/src/lib.rs b/io/zenoh-links/zenoh-link-unixsock_stream/src/lib.rs index 771782e62a..8814ae2a10 100644 --- a/io/zenoh-links/zenoh-link-unixsock_stream/src/lib.rs +++ b/io/zenoh-links/zenoh-link-unixsock_stream/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use async_trait::async_trait; use zenoh_core::zconfigurable; use zenoh_link_commons::LocatorInspector; diff --git a/io/zenoh-links/zenoh-link-vsock/README.md b/io/zenoh-links/zenoh-link-vsock/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/io/zenoh-links/zenoh-link-vsock/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/io/zenoh-links/zenoh-link-vsock/src/lib.rs b/io/zenoh-links/zenoh-link-vsock/src/lib.rs index d58250fed3..f4fe9edf2c 100644 --- a/io/zenoh-links/zenoh-link-vsock/src/lib.rs +++ b/io/zenoh-links/zenoh-link-vsock/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) //! //! Implements [vsock](https://man7.org/linux/man-pages/man7/vsock.7.html) link support. use async_trait::async_trait; diff --git a/io/zenoh-links/zenoh-link-ws/README.md b/io/zenoh-links/zenoh-link-ws/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/io/zenoh-links/zenoh-link-ws/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/io/zenoh-links/zenoh-link-ws/src/lib.rs b/io/zenoh-links/zenoh-link-ws/src/lib.rs index 6a97ed99b6..88961cd1ab 100644 --- a/io/zenoh-links/zenoh-link-ws/src/lib.rs +++ b/io/zenoh-links/zenoh-link-ws/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::net::SocketAddr; use async_trait::async_trait; diff --git a/io/zenoh-transport/src/lib.rs b/io/zenoh-transport/src/lib.rs index bfdd79685d..e603563b6e 100644 --- a/io/zenoh-transport/src/lib.rs +++ b/io/zenoh-transport/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) pub mod common; pub mod manager; pub mod multicast; diff --git a/plugins/zenoh-plugin-rest/src/lib.rs b/plugins/zenoh-plugin-rest/src/lib.rs index ace93275a8..c06fc09951 100644 --- a/plugins/zenoh-plugin-rest/src/lib.rs +++ b/plugins/zenoh-plugin-rest/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::{ borrow::Cow, convert::TryFrom, diff --git a/plugins/zenoh-plugin-storage-manager/src/lib.rs b/plugins/zenoh-plugin-storage-manager/src/lib.rs index 5c3f0ed773..ee9675076a 100644 --- a/plugins/zenoh-plugin-storage-manager/src/lib.rs +++ b/plugins/zenoh-plugin-storage-manager/src/lib.rs @@ -16,7 +16,7 @@ //! //! This crate is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) #![recursion_limit = "512"] use std::{ diff --git a/plugins/zenoh-plugin-trait/src/lib.rs b/plugins/zenoh-plugin-trait/src/lib.rs index 8834bdf04c..5bcb6f5738 100644 --- a/plugins/zenoh-plugin-trait/src/lib.rs +++ b/plugins/zenoh-plugin-trait/src/lib.rs @@ -14,6 +14,8 @@ //! # The plugin infrastructure for Zenoh. //! +//!
This API has been marked as unstable: it works as advertised, but it may be changed in a future release.
+//! //! To build a plugin, implement [`Plugin`]. //! //! If building a plugin for [`zenohd`](https://crates.io/crates/zenoh), you should use the types exported in [`zenoh::plugins`](https://docs.rs/zenoh/latest/zenoh/plugins) to fill [`Plugin`]'s associated types. diff --git a/zenoh-ext/README.md b/zenoh-ext/README.md new file mode 100644 index 0000000000..65a29107b9 --- /dev/null +++ b/zenoh-ext/README.md @@ -0,0 +1,8 @@ +# ⚠️ WARNING ⚠️ + +This crate is intended for Zenoh's internal use. + +- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) +- [Click here for Zenoh's documentation](https://zenoh.io) + + diff --git a/zenoh-ext/src/querying_subscriber.rs b/zenoh-ext/src/querying_subscriber.rs index 80e00741c1..5ef7ffa049 100644 --- a/zenoh-ext/src/querying_subscriber.rs +++ b/zenoh-ext/src/querying_subscriber.rs @@ -162,8 +162,10 @@ impl<'b, Handler> QueryingSubscriberBuilder<'_, 'b, crate::UserSpace, Handler> { self } + /// + /// /// Restrict the matching publications that will be receive by this [`Subscriber`] - /// to the ones that have the given [`Locality`](zenoh::prelude::Locality). + /// to the ones that have the given [`Locality`](Locality). #[zenoh_macros::unstable] #[inline] pub fn allowed_origin(mut self, origin: Locality) -> Self { @@ -536,7 +538,7 @@ where } /// Restrict the matching publications that will be receive by this [`FetchingSubscriber`] - /// to the ones that have the given [`Locality`](zenoh::prelude::Locality). + /// to the ones that have the given [`Locality`](Locality). #[zenoh_macros::unstable] #[inline] pub fn allowed_origin(mut self, origin: Locality) -> Self { diff --git a/zenoh/src/api/builders/publisher.rs b/zenoh/src/api/builders/publisher.rs index 40389ff546..ec59fc58ee 100644 --- a/zenoh/src/api/builders/publisher.rs +++ b/zenoh/src/api/builders/publisher.rs @@ -107,8 +107,10 @@ impl QoSBuilderTrait for PublicationBuilder, T> { } impl PublicationBuilder, T> { + /// + /// /// Restrict the matching subscribers that will receive the published data - /// to the ones that have the given [`Locality`](crate::prelude::Locality). + /// to the ones that have the given [`Locality`](Locality). #[zenoh_macros::unstable] #[inline] pub fn allowed_destination(mut self, destination: Locality) -> Self { @@ -321,8 +323,10 @@ impl QoSBuilderTrait for PublisherBuilder<'_, '_> { } impl<'a, 'b> PublisherBuilder<'a, 'b> { + /// + /// /// Restrict the matching subscribers that will receive the published data - /// to the ones that have the given [`Locality`](crate::prelude::Locality). + /// to the ones that have the given [`Locality`](Locality). #[zenoh_macros::unstable] #[inline] pub fn allowed_destination(mut self, destination: Locality) -> Self { diff --git a/zenoh/src/api/liveliness.rs b/zenoh/src/api/liveliness.rs index 9b96a9a066..06a6f21b0d 100644 --- a/zenoh/src/api/liveliness.rs +++ b/zenoh/src/api/liveliness.rs @@ -34,9 +34,8 @@ use super::{ }; use crate::api::session::WeakSession; -/// A structure with functions to declare a -/// [`LivelinessToken`](LivelinessToken), query -/// existing [`LivelinessTokens`](LivelinessToken) +/// A structure with functions to declare a [`LivelinessToken`](LivelinessToken), +/// query existing [`LivelinessTokens`](LivelinessToken) /// and subscribe to liveliness changes. /// /// A [`LivelinessToken`](LivelinessToken) is a token which liveliness is tied @@ -92,6 +91,7 @@ use crate::api::session::WeakSession; /// } /// # } /// ``` + #[zenoh_macros::unstable] pub struct Liveliness<'a> { pub(crate) session: &'a Session, @@ -278,8 +278,7 @@ pub(crate) struct LivelinessTokenState { pub(crate) key_expr: KeyExpr<'static>, } -/// A token whose liveliness is tied to the Zenoh [`Session`](Session) -/// and can be monitored by remote applications. +/// A token whose liveliness is tied to the Zenoh [`Session`](Session). /// /// A declared liveliness token will be seen as alive by any other Zenoh /// application in the system that monitors it while the liveliness token @@ -406,7 +405,7 @@ impl Drop for LivelinessToken { } } -/// A builder for initializing a liveliness [`FlumeSubscriber`](FlumeSubscriber). +/// A builder for initializing a liveliness. /// /// # Examples /// ``` @@ -503,7 +502,7 @@ impl<'a, 'b> LivelinessSubscriberBuilder<'a, 'b, DefaultHandler> { self.callback(locked(callback)) } - /// Receive the samples for this liveliness subscription with a [`Handler`](crate::prelude::IntoHandler). + /// Receive the samples for this liveliness subscription with a [`Handler`](IntoHandler). /// /// # Examples /// ```no_run diff --git a/zenoh/src/api/publisher.rs b/zenoh/src/api/publisher.rs index 7db74eb89d..5c12150d29 100644 --- a/zenoh/src/api/publisher.rs +++ b/zenoh/src/api/publisher.rs @@ -608,7 +608,7 @@ impl<'a, 'b> MatchingListenerBuilder<'a, 'b, DefaultHandler> { self.callback(crate::api::handlers::locked(callback)) } - /// Receive the MatchingStatuses for this listener with a [`Handler`](crate::prelude::IntoHandler). + /// Receive the MatchingStatuses for this listener with a [`Handler`](IntoHandler). /// /// # Examples /// ```no_run diff --git a/zenoh/src/api/query.rs b/zenoh/src/api/query.rs index eee1bee9f2..5134158826 100644 --- a/zenoh/src/api/query.rs +++ b/zenoh/src/api/query.rs @@ -407,8 +407,10 @@ impl<'a, 'b, Handler> SessionGetBuilder<'a, 'b, Handler> { } } + /// + /// /// Restrict the matching queryables that will receive the query - /// to the ones that have the given [`Locality`](crate::prelude::Locality). + /// to the ones that have the given [`Locality`](Locality). #[zenoh_macros::unstable] #[inline] pub fn allowed_destination(self, destination: Locality) -> Self { @@ -424,6 +426,8 @@ impl<'a, 'b, Handler> SessionGetBuilder<'a, 'b, Handler> { Self { timeout, ..self } } + /// + /// /// By default, `get` guarantees that it will only receive replies whose key expressions intersect /// with the queried key expression. /// diff --git a/zenoh/src/api/queryable.rs b/zenoh/src/api/queryable.rs index e1a0ce5257..07ed7e4611 100644 --- a/zenoh/src/api/queryable.rs +++ b/zenoh/src/api/queryable.rs @@ -719,8 +719,10 @@ impl QueryableBuilder<'_, '_, Handler> { self } + /// + /// /// Restrict the matching queries that will be receive by this [`Queryable`] - /// to the ones that have the given [`Locality`](crate::prelude::Locality). + /// to the ones that have the given [`Locality`](Locality). #[inline] #[zenoh_macros::unstable] pub fn allowed_origin(mut self, origin: Locality) -> Self { diff --git a/zenoh/src/api/session.rs b/zenoh/src/api/session.rs index da67e1a163..75f060adb0 100644 --- a/zenoh/src/api/session.rs +++ b/zenoh/src/api/session.rs @@ -626,7 +626,7 @@ impl Session { /// Get the current configuration of the zenoh [`Session`](Session). /// - /// The returned configuration [`Notifier`](Notifier) can be used to read the current + /// The returned configuration [`Notifier`](crate::config::Notifier) can be used to read the current /// zenoh configuration through the `get` function or /// modify the zenoh configuration through the `insert`, /// or `insert_json5` function. diff --git a/zenoh/src/api/subscriber.rs b/zenoh/src/api/subscriber.rs index c8c45ae09a..a79bdc4aed 100644 --- a/zenoh/src/api/subscriber.rs +++ b/zenoh/src/api/subscriber.rs @@ -281,7 +281,7 @@ impl SubscriberBuilder<'_, '_, Handler> { } /// Restrict the matching publications that will be receive by this [`Subscriber`] - /// to the ones that have the given [`Locality`](crate::prelude::Locality). + /// to the ones that have the given [`Locality`](Locality). #[zenoh_macros::unstable] #[inline] pub fn allowed_origin(mut self, origin: Locality) -> Self { diff --git a/zenoh/src/lib.rs b/zenoh/src/lib.rs index 4c0522475e..037d9e2a53 100644 --- a/zenoh/src/lib.rs +++ b/zenoh/src/lib.rs @@ -418,6 +418,7 @@ pub mod internal { pub use crate::api::value::Value; } +/// Shared memory. #[zenoh_macros::unstable] #[cfg(feature = "shared-memory")] pub mod shm { diff --git a/zenoh/src/net/mod.rs b/zenoh/src/net/mod.rs index 346426a630..05f29c65fc 100644 --- a/zenoh/src/net/mod.rs +++ b/zenoh/src/net/mod.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) #[doc(hidden)] pub(crate) mod codec; #[doc(hidden)] diff --git a/zenoh/src/net/routing/dispatcher/mod.rs b/zenoh/src/net/routing/dispatcher/mod.rs index dc17b91b6b..b685443180 100644 --- a/zenoh/src/net/routing/dispatcher/mod.rs +++ b/zenoh/src/net/routing/dispatcher/mod.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) pub mod face; pub mod interests; pub mod pubsub; diff --git a/zenoh/src/net/routing/hat/client/mod.rs b/zenoh/src/net/routing/hat/client/mod.rs index a1a1eb08d1..04ab653d9f 100644 --- a/zenoh/src/net/routing/hat/client/mod.rs +++ b/zenoh/src/net/routing/hat/client/mod.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::{ any::Any, collections::HashMap, diff --git a/zenoh/src/net/routing/hat/linkstate_peer/mod.rs b/zenoh/src/net/routing/hat/linkstate_peer/mod.rs index 3dedbfa462..167d9ae58b 100644 --- a/zenoh/src/net/routing/hat/linkstate_peer/mod.rs +++ b/zenoh/src/net/routing/hat/linkstate_peer/mod.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::{ any::Any, collections::{HashMap, HashSet}, diff --git a/zenoh/src/net/routing/hat/mod.rs b/zenoh/src/net/routing/hat/mod.rs index 8a8ddfebf2..3e5a81d259 100644 --- a/zenoh/src/net/routing/hat/mod.rs +++ b/zenoh/src/net/routing/hat/mod.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::{any::Any, sync::Arc}; use zenoh_config::{unwrap_or_default, Config, WhatAmI}; diff --git a/zenoh/src/net/routing/hat/p2p_peer/mod.rs b/zenoh/src/net/routing/hat/p2p_peer/mod.rs index 2f5aef911c..4d20204c19 100644 --- a/zenoh/src/net/routing/hat/p2p_peer/mod.rs +++ b/zenoh/src/net/routing/hat/p2p_peer/mod.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::{ any::Any, collections::HashMap, diff --git a/zenoh/src/net/routing/hat/router/mod.rs b/zenoh/src/net/routing/hat/router/mod.rs index 7ffc568d5c..c7ea567fb4 100644 --- a/zenoh/src/net/routing/hat/router/mod.rs +++ b/zenoh/src/net/routing/hat/router/mod.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::{ any::Any, collections::{hash_map::DefaultHasher, HashMap, HashSet}, diff --git a/zenoh/src/net/routing/interceptor/access_control.rs b/zenoh/src/net/routing/interceptor/access_control.rs index 839f18bd07..9df0bdc489 100644 --- a/zenoh/src/net/routing/interceptor/access_control.rs +++ b/zenoh/src/net/routing/interceptor/access_control.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::{any::Any, collections::HashSet, iter, sync::Arc}; diff --git a/zenoh/src/net/routing/interceptor/authorization.rs b/zenoh/src/net/routing/interceptor/authorization.rs index a7446382d1..ae70f11a46 100644 --- a/zenoh/src/net/routing/interceptor/authorization.rs +++ b/zenoh/src/net/routing/interceptor/authorization.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::collections::HashMap; use ahash::RandomState; diff --git a/zenoh/src/net/routing/interceptor/downsampling.rs b/zenoh/src/net/routing/interceptor/downsampling.rs index c8881341e0..04064531d5 100644 --- a/zenoh/src/net/routing/interceptor/downsampling.rs +++ b/zenoh/src/net/routing/interceptor/downsampling.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) use std::{ collections::HashMap, diff --git a/zenoh/src/net/routing/interceptor/mod.rs b/zenoh/src/net/routing/interceptor/mod.rs index ba0209de2d..198ed2aa06 100644 --- a/zenoh/src/net/routing/interceptor/mod.rs +++ b/zenoh/src/net/routing/interceptor/mod.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) //! mod access_control; use access_control::acl_interceptor_factories; diff --git a/zenoh/src/net/routing/mod.rs b/zenoh/src/net/routing/mod.rs index f4a5e4c2da..cc1778b9ba 100644 --- a/zenoh/src/net/routing/mod.rs +++ b/zenoh/src/net/routing/mod.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) pub mod dispatcher; pub mod hat; pub mod interceptor; diff --git a/zenoh/src/net/runtime/mod.rs b/zenoh/src/net/runtime/mod.rs index a0aa53044a..9f3a1a6c21 100644 --- a/zenoh/src/net/runtime/mod.rs +++ b/zenoh/src/net/runtime/mod.rs @@ -16,7 +16,7 @@ //! //! This module is intended for Zenoh's internal use. //! -//! [Click here for Zenoh's documentation](../zenoh/index.html) +//! [Click here for Zenoh's documentation](https://docs.rs/zenoh/latest/zenoh) mod adminspace; pub mod orchestrator;