From 102f4da4eea6a6299151aa4d8ec1e277106f0ea3 Mon Sep 17 00:00:00 2001 From: Troels Peter Jessen Date: Sat, 1 Jan 2022 20:38:25 +0100 Subject: [PATCH 1/4] Added missing docs and added warn on missing docs --- crates/bevy_internal/src/lib.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/crates/bevy_internal/src/lib.rs b/crates/bevy_internal/src/lib.rs index a0548274abcca..7dad0b5b82ae4 100644 --- a/crates/bevy_internal/src/lib.rs +++ b/crates/bevy_internal/src/lib.rs @@ -1,3 +1,6 @@ +#![warn(missing_docs)] +//! This module contains plugins for quickly setting up a Bevy app, as well as publicizing of the subcrates Bevy contains + /// `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,6 +136,7 @@ pub mod ui { #[cfg(feature = "bevy_winit")] pub mod winit { + //! Window creation, configuration, and handling pub use bevy_winit::*; } From faab853af5e769e0fdf712c9211dd57195e241bf Mon Sep 17 00:00:00 2001 From: Troels Peter Jessen Date: Sat, 1 Jan 2022 20:48:47 +0100 Subject: [PATCH 2/4] Added missing doc --- crates/bevy_internal/src/lib.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/crates/bevy_internal/src/lib.rs b/crates/bevy_internal/src/lib.rs index 7dad0b5b82ae4..36ef530f2f6d8 100644 --- a/crates/bevy_internal/src/lib.rs +++ b/crates/bevy_internal/src/lib.rs @@ -142,6 +142,7 @@ pub mod winit { #[cfg(feature = "bevy_dynamic_plugin")] pub mod dynamic_plugin { + //! Dynamic linking of plugins pub use bevy_dynamic_plugin::*; } From 78da696749229fa40e7e9a944b76ee88e5c52b7f Mon Sep 17 00:00:00 2001 From: Troels Peter Jessen Date: Sat, 1 Jan 2022 21:37:23 +0100 Subject: [PATCH 3/4] Updated doc --- crates/bevy_internal/src/lib.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/crates/bevy_internal/src/lib.rs b/crates/bevy_internal/src/lib.rs index 36ef530f2f6d8..7af97a3ec6f63 100644 --- a/crates/bevy_internal/src/lib.rs +++ b/crates/bevy_internal/src/lib.rs @@ -1,5 +1,7 @@ #![warn(missing_docs)] //! This module contains plugins for quickly setting up a Bevy app, as well as publicizing of the subcrates Bevy contains +//! +//! This module is separated into its own crate to enable simple dynamic linking for Bevy /// `use bevy::prelude::*;` to import common components, bundles, and plugins. pub mod prelude; From 81a699cff70354710e718e242d09843928aec4f8 Mon Sep 17 00:00:00 2001 From: Troels Peter Jessen Date: Sat, 1 Jan 2022 21:49:50 +0100 Subject: [PATCH 4/4] Updated crate doc to be more accurate --- crates/bevy_internal/src/lib.rs | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/crates/bevy_internal/src/lib.rs b/crates/bevy_internal/src/lib.rs index 7af97a3ec6f63..dd7d9d58cd11c 100644 --- a/crates/bevy_internal/src/lib.rs +++ b/crates/bevy_internal/src/lib.rs @@ -1,7 +1,5 @@ #![warn(missing_docs)] -//! This module contains plugins for quickly setting up a Bevy app, as well as publicizing of the subcrates Bevy contains -//! -//! This module is separated into its own crate to enable simple dynamic linking for Bevy +//! 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;