130953c717
# Objective CI should check for missing backticks in doc comments. Fixes #3435 ## Solution `clippy` has a lint for this: `doc_markdown`. This enables that lint in the CI script. Of course, enabling this lint in CI causes a bunch of lint errors, so I've gone through and fixed all of them. This was a huge edit that touched a ton of files, so I split the PR up by crate. When all of the following are merged, the CI should pass and this can be merged. + [x] #3467 + [x] #3468 + [x] #3470 + [x] #3469 + [x] #3471 + [x] #3472 + [x] #3473 + [x] #3474 + [x] #3475 + [x] #3476 + [x] #3477 + [x] #3478 + [x] #3479 + [x] #3480 + [x] #3481 + [x] #3482 + [x] #3483 + [x] #3484 + [x] #3485 + [x] #3486
21 lines
777 B
Rust
21 lines
777 B
Rust
use crate::App;
|
|
use std::any::Any;
|
|
|
|
/// A collection of Bevy App logic and configuration
|
|
///
|
|
/// Plugins configure an [`App`](crate::App). When an [`App`](crate::App) registers
|
|
/// a plugin, the plugin's [`Plugin::build`] function is run.
|
|
pub trait Plugin: Any + Send + Sync {
|
|
/// Configures the [`App`] to which this plugin is added.
|
|
fn build(&self, app: &mut App);
|
|
/// Configures a name for the [`Plugin`]. Primarily for debugging.
|
|
fn name(&self) -> &str {
|
|
std::any::type_name::<Self>()
|
|
}
|
|
}
|
|
|
|
/// Type representing an unsafe function that returns a mutable pointer to a [`Plugin`].
|
|
/// Used for dynamically loading plugins. See
|
|
/// `bevy_dynamic_plugin/src/loader.rs#dynamically_load_plugin`
|
|
pub type CreatePlugin = unsafe fn() -> *mut dyn Plugin;
|