694c06f3d0
# Objective Currently the `missing_docs` lint is allowed-by-default and enabled at crate level when their documentations is complete (see #3492). This PR proposes to inverse this logic by making `missing_docs` warn-by-default and mark crates with imcomplete docs allowed. ## Solution Makes `missing_docs` warn at workspace level and allowed at crate level when the docs is imcomplete.
36 lines
1.3 KiB
Rust
36 lines
1.3 KiB
Rust
// FIXME(3492): remove once docs are ready
|
|
#![allow(missing_docs)]
|
|
|
|
//! This crate provides a straightforward solution for integrating diagnostics in the [Bevy game engine](https://bevyengine.org/).
|
|
//! It allows users to easily add diagnostic functionality to their Bevy applications, enhancing
|
|
//! their ability to monitor and optimize their game's.
|
|
|
|
mod diagnostic;
|
|
mod entity_count_diagnostics_plugin;
|
|
mod frame_time_diagnostics_plugin;
|
|
mod log_diagnostics_plugin;
|
|
mod system_information_diagnostics_plugin;
|
|
|
|
use bevy_app::prelude::*;
|
|
pub use diagnostic::*;
|
|
pub use entity_count_diagnostics_plugin::EntityCountDiagnosticsPlugin;
|
|
pub use frame_time_diagnostics_plugin::FrameTimeDiagnosticsPlugin;
|
|
pub use log_diagnostics_plugin::LogDiagnosticsPlugin;
|
|
pub use system_information_diagnostics_plugin::SystemInformationDiagnosticsPlugin;
|
|
|
|
/// Adds core diagnostics resources to an App.
|
|
#[derive(Default)]
|
|
pub struct DiagnosticsPlugin;
|
|
|
|
impl Plugin for DiagnosticsPlugin {
|
|
fn build(&self, app: &mut App) {
|
|
app.init_resource::<DiagnosticsStore>().add_systems(
|
|
Startup,
|
|
system_information_diagnostics_plugin::internal::log_system_info,
|
|
);
|
|
}
|
|
}
|
|
|
|
/// Default max history length for new diagnostics.
|
|
pub const DEFAULT_MAX_HISTORY_LENGTH: usize = 120;
|