Skip to content

Commit

Permalink
Added missing docs to bevy_internal and added warn on missing docs (#…
Browse files Browse the repository at this point in the history
…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
  • Loading branch information
Troels Jessen committed Jan 1, 2022
1 parent 97c8065 commit 5c590b0
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions crates/bevy_internal/src/lib.rs
Original file line number Diff line number Diff line change
@@ -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;

Expand Down Expand Up @@ -68,6 +71,7 @@ pub mod transform {
}

pub mod utils {
//! Various miscellaneous utilities for easing development
pub use bevy_utils::*;
}

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

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

Expand Down

0 comments on commit 5c590b0

Please sign in to comment.