Skip to content

[Merged by Bors] - Added missing docs to bevy_internal and added warn on missing docs #3514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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