From 5c590b0011733165a0c9dd9b908083ad912d36d1 Mon Sep 17 00:00:00 2001 From: Troels Jessen Date: Sat, 1 Jan 2022 21:22:04 +0000 Subject: [PATCH] Added missing docs to bevy_internal and added warn on missing docs (#3514) # Objective This contributes documentation that should cover the entirety of bevy_internal as requested in #3492 ## Solution warn(missing_docs) has been activated and documentation has been added to missing parts so that no warnings appear from this setting --- crates/bevy_internal/src/lib.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/crates/bevy_internal/src/lib.rs b/crates/bevy_internal/src/lib.rs index a0548274ab..dd7d9d58cd 100644 --- a/crates/bevy_internal/src/lib.rs +++ b/crates/bevy_internal/src/lib.rs @@ -1,3 +1,6 @@ +#![warn(missing_docs)] +//! This module is separated into its own crate to enable simple dynamic linking for Bevy, and should not be used directly + /// `use bevy::prelude::*;` to import common components, bundles, and plugins. pub mod prelude; @@ -68,6 +71,7 @@ pub mod transform { } pub mod utils { + //! Various miscellaneous utilities for easing development pub use bevy_utils::*; } @@ -90,6 +94,7 @@ pub mod core_pipeline { #[cfg(feature = "bevy_gilrs")] pub mod gilrs { + //! Bevy interface with GilRs - Game Input Library for Rust to handle gamepad inputs pub use bevy_gilrs::*; } @@ -131,11 +136,13 @@ pub mod ui { #[cfg(feature = "bevy_winit")] pub mod winit { + //! Window creation, configuration, and handling pub use bevy_winit::*; } #[cfg(feature = "bevy_dynamic_plugin")] pub mod dynamic_plugin { + //! Dynamic linking of plugins pub use bevy_dynamic_plugin::*; }