forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Added missing docs to bevy_internal and added warn on missing docs (#3514)

Browse Source 
# 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
This commit is contained in:
Troels Jessen 2022-01-01 21:22:04 +00:00
parent 97c806585b
commit 5c590b0011
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
crates/bevy_internal/src/lib.rs
View File

@ -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::*;
}