diff --git a/crates/ironrdp-acceptor/src/lib.rs b/crates/ironrdp-acceptor/src/lib.rs index df38f91f..02392670 100644 --- a/crates/ironrdp-acceptor/src/lib.rs +++ b/crates/ironrdp-acceptor/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + #[macro_use] extern crate tracing; diff --git a/crates/ironrdp-ainput/src/lib.rs b/crates/ironrdp-ainput/src/lib.rs index 28bf3d0d..2649bc74 100644 --- a/crates/ironrdp-ainput/src/lib.rs +++ b/crates/ironrdp-ainput/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + use bitflags::bitflags; use ironrdp_dvc::DvcEncode; use num_derive::{FromPrimitive, ToPrimitive}; diff --git a/crates/ironrdp-async/src/lib.rs b/crates/ironrdp-async/src/lib.rs index 12cd21ba..a5601d7f 100644 --- a/crates/ironrdp-async/src/lib.rs +++ b/crates/ironrdp-async/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + #[macro_use] extern crate tracing; diff --git a/crates/ironrdp-blocking/src/lib.rs b/crates/ironrdp-blocking/src/lib.rs index 31d6fc1d..f5618ea1 100644 --- a/crates/ironrdp-blocking/src/lib.rs +++ b/crates/ironrdp-blocking/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + #[macro_use] extern crate tracing; diff --git a/crates/ironrdp-client/src/lib.rs b/crates/ironrdp-client/src/lib.rs index 51b5dc60..7a61c7a6 100644 --- a/crates/ironrdp-client/src/lib.rs +++ b/crates/ironrdp-client/src/lib.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] #![allow(unused_crate_dependencies)] // false positives because there is both a library and a binary // No need to be as strict as in production libraries diff --git a/crates/ironrdp-connector/src/lib.rs b/crates/ironrdp-connector/src/lib.rs index abfac649..2336ed6b 100644 --- a/crates/ironrdp-connector/src/lib.rs +++ b/crates/ironrdp-connector/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + #[macro_use] extern crate tracing; diff --git a/crates/ironrdp-core/src/lib.rs b/crates/ironrdp-core/src/lib.rs index a42b6001..00abe1f8 100644 --- a/crates/ironrdp-core/src/lib.rs +++ b/crates/ironrdp-core/src/lib.rs @@ -1,5 +1,5 @@ -#![cfg_attr(not(feature = "std"), no_std)] #![doc = include_str!("../README.md")] +#![cfg_attr(not(feature = "std"), no_std)] #![warn(clippy::std_instead_of_alloc)] #![warn(clippy::std_instead_of_core)] #![warn(missing_docs)] diff --git a/crates/ironrdp-dvc/src/lib.rs b/crates/ironrdp-dvc/src/lib.rs index 23dcc27f..f99a5a59 100644 --- a/crates/ironrdp-dvc/src/lib.rs +++ b/crates/ironrdp-dvc/src/lib.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] #![cfg_attr(not(feature = "std"), no_std)] #[macro_use] diff --git a/crates/ironrdp-error/src/lib.rs b/crates/ironrdp-error/src/lib.rs index 07cada2a..8e6f1f53 100644 --- a/crates/ironrdp-error/src/lib.rs +++ b/crates/ironrdp-error/src/lib.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] #![cfg_attr(not(feature = "std"), no_std)] #[cfg(feature = "alloc")] diff --git a/crates/ironrdp-futures/src/lib.rs b/crates/ironrdp-futures/src/lib.rs index 03a98ac5..22a30f53 100644 --- a/crates/ironrdp-futures/src/lib.rs +++ b/crates/ironrdp-futures/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + #[rustfmt::skip] // do not re-order this pub use pub use ironrdp_async::*; diff --git a/crates/ironrdp-glutin-renderer/src/lib.rs b/crates/ironrdp-glutin-renderer/src/lib.rs index d789355a..c9cf6624 100644 --- a/crates/ironrdp-glutin-renderer/src/lib.rs +++ b/crates/ironrdp-glutin-renderer/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + #[macro_use] extern crate tracing; diff --git a/crates/ironrdp-graphics/src/lib.rs b/crates/ironrdp-graphics/src/lib.rs index c676af8d..7a5e7d3b 100644 --- a/crates/ironrdp-graphics/src/lib.rs +++ b/crates/ironrdp-graphics/src/lib.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] #![allow(clippy::arithmetic_side_effects)] // FIXME: remove #![allow(clippy::cast_lossless)] // FIXME: remove #![allow(clippy::cast_possible_truncation)] // FIXME: remove diff --git a/crates/ironrdp-input/src/lib.rs b/crates/ironrdp-input/src/lib.rs index 9986ffed..3000e490 100644 --- a/crates/ironrdp-input/src/lib.rs +++ b/crates/ironrdp-input/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + use bitvec::array::BitArray; use bitvec::BitArr; use ironrdp_pdu::input::fast_path::{FastPathInputEvent, KeyboardFlags}; diff --git a/crates/ironrdp-pdu-generators/src/lib.rs b/crates/ironrdp-pdu-generators/src/lib.rs index d4bd0bf7..247e8f96 100644 --- a/crates/ironrdp-pdu-generators/src/lib.rs +++ b/crates/ironrdp-pdu-generators/src/lib.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] // No need to be as strict as in production libraries #![allow(clippy::arithmetic_side_effects)] #![allow(clippy::cast_lossless)] diff --git a/crates/ironrdp-pdu/src/lib.rs b/crates/ironrdp-pdu/src/lib.rs index 56686291..6aac9b31 100644 --- a/crates/ironrdp-pdu/src/lib.rs +++ b/crates/ironrdp-pdu/src/lib.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] #![allow(clippy::arithmetic_side_effects)] // FIXME: remove #![allow(clippy::cast_lossless)] // FIXME: remove #![allow(clippy::cast_possible_truncation)] // FIXME: remove diff --git a/crates/ironrdp-rdcleanpath/src/lib.rs b/crates/ironrdp-rdcleanpath/src/lib.rs index a2e28c60..5af12ea6 100644 --- a/crates/ironrdp-rdcleanpath/src/lib.rs +++ b/crates/ironrdp-rdcleanpath/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + use core::fmt; use der::asn1::OctetString; diff --git a/crates/ironrdp-rdpsnd-native/src/lib.rs b/crates/ironrdp-rdpsnd-native/src/lib.rs index a497a65c..1fae2eff 100644 --- a/crates/ironrdp-rdpsnd-native/src/lib.rs +++ b/crates/ironrdp-rdpsnd-native/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + #[macro_use] extern crate tracing; diff --git a/crates/ironrdp-rdpsnd/src/lib.rs b/crates/ironrdp-rdpsnd/src/lib.rs index e5dac829..6ccd9fe5 100644 --- a/crates/ironrdp-rdpsnd/src/lib.rs +++ b/crates/ironrdp-rdpsnd/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + pub mod client; pub mod pdu; pub mod server; diff --git a/crates/ironrdp-server/src/lib.rs b/crates/ironrdp-server/src/lib.rs index 7fd65aa3..b1f2360c 100644 --- a/crates/ironrdp-server/src/lib.rs +++ b/crates/ironrdp-server/src/lib.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] #![allow(clippy::arithmetic_side_effects)] // TODO: should we enable this lint back? pub use tokio; diff --git a/crates/ironrdp-session-generators/src/lib.rs b/crates/ironrdp-session-generators/src/lib.rs index d4bd0bf7..247e8f96 100644 --- a/crates/ironrdp-session-generators/src/lib.rs +++ b/crates/ironrdp-session-generators/src/lib.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] // No need to be as strict as in production libraries #![allow(clippy::arithmetic_side_effects)] #![allow(clippy::cast_lossless)] diff --git a/crates/ironrdp-session/src/lib.rs b/crates/ironrdp-session/src/lib.rs index 4f64d04f..3d6bec77 100644 --- a/crates/ironrdp-session/src/lib.rs +++ b/crates/ironrdp-session/src/lib.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] #![allow(clippy::arithmetic_side_effects)] // FIXME: remove #[macro_use] diff --git a/crates/ironrdp-svc/src/lib.rs b/crates/ironrdp-svc/src/lib.rs index 8e86d47b..7898dc6c 100644 --- a/crates/ironrdp-svc/src/lib.rs +++ b/crates/ironrdp-svc/src/lib.rs @@ -1,4 +1,5 @@ #![doc = include_str!("../README.md")] + // TODO: #![warn(missing_docs)] extern crate alloc; diff --git a/crates/ironrdp-tokio/src/lib.rs b/crates/ironrdp-tokio/src/lib.rs index 039b55ac..65804608 100644 --- a/crates/ironrdp-tokio/src/lib.rs +++ b/crates/ironrdp-tokio/src/lib.rs @@ -1,3 +1,5 @@ +#![doc = include_str!("../README.md")] + #[rustfmt::skip] // do not re-order this pub use pub use ironrdp_async::*; diff --git a/crates/ironrdp-web/src/lib.rs b/crates/ironrdp-web/src/lib.rs index 3680ca58..db4e0a8e 100644 --- a/crates/ironrdp-web/src/lib.rs +++ b/crates/ironrdp-web/src/lib.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] #![allow(clippy::new_without_default)] // Default trait can’t be used by wasm consumer anyway #![allow(unsafe_op_in_unsafe_fn)] // We can’t control code generated by `wasm-bindgen` diff --git a/crates/ironrdp/src/lib.rs b/crates/ironrdp/src/lib.rs index c812c621..91d5e0ac 100644 --- a/crates/ironrdp/src/lib.rs +++ b/crates/ironrdp/src/lib.rs @@ -1,6 +1,4 @@ -//! Rust implementation of the Remote Desktop Protocol (RDP). -//! -//! This is a meta crate re-exporting other ironrdp crates for convenience. +#![doc = include_str!("../../../README.md")] #[cfg(feature = "acceptor")] pub use ironrdp_acceptor as acceptor; diff --git a/crates/now-proto-pdu/src/lib.rs b/crates/now-proto-pdu/src/lib.rs index 47d30481..a260b0f0 100644 --- a/crates/now-proto-pdu/src/lib.rs +++ b/crates/now-proto-pdu/src/lib.rs @@ -1,6 +1,4 @@ -//! This crate provides implementation of [NOW_PROTO] protocol. -//! -//! [NOW_PROTO]: ../../../docs/NOW-spec.md +#![doc = include_str!("../README.md")] #![cfg_attr(not(feature = "std"), no_std)] extern crate alloc;