diff --git a/crates/bevy_asset/src/asset_server.rs b/crates/bevy_asset/src/asset_server.rs index c059428209cb85..88f20511ab79ca 100644 --- a/crates/bevy_asset/src/asset_server.rs +++ b/crates/bevy_asset/src/asset_server.rs @@ -14,7 +14,7 @@ use parking_lot::{Mutex, RwLock}; use std::{collections::hash_map::Entry, path::Path, sync::Arc}; use thiserror::Error; -/// Errors that occur while loading assets with an AssetServer +/// Errors that occur while loading assets with an `AssetServer` #[derive(Error, Debug)] pub enum AssetServerError { #[error("asset folder path is not a directory: {0}")] @@ -215,7 +215,7 @@ impl AssetServer { /// Queue an [`Asset`] at the provided relative path for asynchronous loading. /// - /// The absolute Path to the asset is "ROOT/ASSET_FOLDER_NAME/path". + /// The absolute Path to the asset is `"ROOT/ASSET_FOLDER_NAME/path"`. /// /// By default the ROOT is the directory of the Application, but this can be overridden by /// setting the `"CARGO_MANIFEST_DIR"` environment variable diff --git a/crates/bevy_asset/src/io/mod.rs b/crates/bevy_asset/src/io/mod.rs index a40b7b2d013b62..acff0ec0136002 100644 --- a/crates/bevy_asset/src/io/mod.rs +++ b/crates/bevy_asset/src/io/mod.rs @@ -32,7 +32,7 @@ pub enum AssetIoError { PathWatchError(PathBuf), } -/// Handles load requests from an AssetServer +/// Handles load requests from an `AssetServer` pub trait AssetIo: Downcast + Send + Sync + 'static { fn load_path<'a>(&'a self, path: &'a Path) -> BoxedFuture<'a, Result, AssetIoError>>; fn read_directory( diff --git a/crates/bevy_asset/src/loader.rs b/crates/bevy_asset/src/loader.rs index aa12dbddace05a..7b665bf8befe10 100644 --- a/crates/bevy_asset/src/loader.rs +++ b/crates/bevy_asset/src/loader.rs @@ -155,7 +155,7 @@ pub struct AssetResult { pub version: usize, } -/// A channel to send and receive [AssetResult]s +/// A channel to send and receive [`AssetResult`]s #[derive(Debug)] pub struct AssetLifecycleChannel { pub sender: Sender>, @@ -203,7 +203,7 @@ impl Default for AssetLifecycleChannel { } } -/// Updates the [Assets] collection according to the changes queued up by [AssetServer]. +/// Updates the [`Assets`] collection according to the changes queued up by [`AssetServer`]. pub fn update_asset_storage_system( asset_server: Res, assets: ResMut>,