diff --git a/packages/router/src/lib.rs b/packages/router/src/lib.rs index b69fb77c0..50f51705f 100644 --- a/packages/router/src/lib.rs +++ b/packages/router/src/lib.rs @@ -36,14 +36,19 @@ pub mod hooks { pub use use_route::*; } +/// A collection of useful items most applications might need. +#[forbid(missing_docs)] pub mod prelude { pub use dioxus_router_core::prelude::*; pub use crate::components::*; pub use crate::hooks::*; - use dioxus::core::Component; - pub fn comp(component: Component) -> ContentAtom { + /// Wrap a [`Component`](dioxus::core::Component) inside a [`ContentAtom`]. + /// + /// This is purely a convenience function. + #[must_use] + pub fn comp(component: dioxus::core::Component) -> ContentAtom { ContentAtom(component) } }