Skip to content

Commit 5c590b0

Browse files
author
Troels Jessen
committed
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
1 parent 97c8065 commit 5c590b0

File tree

1 file changed

+7
-0
lines changed
  • crates/bevy_internal/src

1 file changed

+7
-0
lines changed

crates/bevy_internal/src/lib.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
#![warn(missing_docs)]
2+
//! This module is separated into its own crate to enable simple dynamic linking for Bevy, and should not be used directly
3+
14
/// `use bevy::prelude::*;` to import common components, bundles, and plugins.
25
pub mod prelude;
36

@@ -68,6 +71,7 @@ pub mod transform {
6871
}
6972

7073
pub mod utils {
74+
//! Various miscellaneous utilities for easing development
7175
pub use bevy_utils::*;
7276
}
7377

@@ -90,6 +94,7 @@ pub mod core_pipeline {
9094

9195
#[cfg(feature = "bevy_gilrs")]
9296
pub mod gilrs {
97+
//! Bevy interface with GilRs - Game Input Library for Rust to handle gamepad inputs
9398
pub use bevy_gilrs::*;
9499
}
95100

@@ -131,11 +136,13 @@ pub mod ui {
131136

132137
#[cfg(feature = "bevy_winit")]
133138
pub mod winit {
139+
//! Window creation, configuration, and handling
134140
pub use bevy_winit::*;
135141
}
136142

137143
#[cfg(feature = "bevy_dynamic_plugin")]
138144
pub mod dynamic_plugin {
145+
//! Dynamic linking of plugins
139146
pub use bevy_dynamic_plugin::*;
140147
}
141148

0 commit comments

Comments
 (0)