Skip to content

Commit db04e3f

Browse files
committed
fix a bunch of docs links
1 parent 1fec623 commit db04e3f

File tree

18 files changed

+34
-34
lines changed

18 files changed

+34
-34
lines changed

crates/bevy_mod_scripting_bindings/src/allocator.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,13 +195,13 @@ pub struct ReflectAllocator {
195195

196196
#[profiling::all_functions]
197197
impl ReflectAllocator {
198-
/// Allocates a new [`Reflect`] value and returns an [`AllocationId`] which can be used to access it later.
198+
/// Allocates a new `Reflect` value and returns an [`ReflectAllocationId`] which can be used to access it later.
199199
/// Use [`Self::allocate_boxed`] if you already have an allocated boxed value.
200200
pub fn allocate<T: PartialReflect>(&mut self, value: T) -> ReflectAllocationId {
201201
self.allocate_boxed(Box::new(value))
202202
}
203203

204-
/// Allocates a new boxed [`PartialReflect`] value and returns an [`AllocationId`] which can be used to access it later.
204+
/// Allocates a new boxed `PartialReflect` value and returns an [`ReflectAllocationId`] which can be used to access it later.
205205
pub fn allocate_boxed(&mut self, value: Box<dyn PartialReflect>) -> ReflectAllocationId {
206206
static COUNTER: AtomicU64 = AtomicU64::new(0);
207207

@@ -236,7 +236,7 @@ impl ReflectAllocator {
236236
self.allocations.get(id)
237237
}
238238

239-
/// Deallocates the [`PartialReflect`] value with the given [`AllocationId`]
239+
/// Deallocates the `PartialReflect` value with the given [`ReflectAllocationId`]
240240
pub fn deallocate(&mut self, id: &ReflectAllocationId) {
241241
self.allocations.remove(id);
242242
}

crates/bevy_mod_scripting_bindings/src/docgen/typed_through.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//! Defines a set of traits which destruture [`bevy::reflect::TypeInfo`] and implement a light weight wrapper around it, to allow types
2-
//! which normally can't implement [`bevy::reflect::Typed`] to be used in a reflection context.
1+
//! Defines a set of traits which destruture [`bevy_reflect::TypeInfo`] and implement a light weight wrapper around it, to allow types
2+
//! which normally can't implement [`bevy_reflect::Typed`] to be used in a reflection context.
33
44
use std::{ffi::OsString, path::PathBuf};
55

crates/bevy_mod_scripting_bindings/src/function/from.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ impl<T: FromReflect> FromScript for Val<T> {
229229
/// Before downcasting the reference, it will claim write access to the object to ensure that the reference is valid.
230230
///
231231
/// However, the access is NOT released when the `Mut` is dropped. This is not unsafe but can lead to deadlocks if not released later.
232-
/// The [`ScriptFunction`] calling mechanism will take care of releasing all accesses claimed during the function call.
232+
/// The script function calling mechanism will take care of releasing all accesses claimed during the function call.
233233
pub struct Ref<'w, T>(pub &'w T);
234234

235235
impl<T> Deref for Ref<'_, T> {

crates/bevy_mod_scripting_bindings/src/function/into_ref.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ use crate::{
1010
reflection_extensions::PartialReflectExt,
1111
};
1212

13-
/// Converts a value represented by a reference into a [`crate::function::ScriptValue`].
13+
/// Converts a value represented by a reference into a [`crate::ScriptValue`].
1414
/// Instead of a direct conversion, the trait tries to peek into the value behind the reference and find out the most suitable representation.
1515
///
1616
/// Type Erased version of [`super::from::FromScript`].
1717
///
1818
/// - Primitives are converted to simple values
1919
/// - Container types are converted to references (so the references persist after accesses inside them)
2020
pub trait IntoScriptRef {
21-
/// Converts a value represented by a reference into a [`crate::function::ScriptValue`].
21+
/// Converts a value represented by a reference into a [`crate::ScriptValue`].
2222
fn into_script_ref(
2323
self_: ReflectReference,
2424
world: WorldGuard,

crates/bevy_mod_scripting_bindings/src/function/script_function.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ where
264264
#[debug_with_type_info(bms_display_path = "bevy_mod_scripting_display")]
265265
pub struct DummyScriptFunctionRegistry(pub ScriptFunctionRegistryArc);
266266

267-
/// Equivalent to [`AppFunctionRegistry`] but stores functions with a more convenient signature for scripting to avoid boxing every argument.
267+
/// Equivalent to [`AppScriptFunctionRegistry`] but stores functions with a more convenient signature for scripting to avoid boxing every argument.
268268
#[derive(Clone, Default, Resource, DebugWithTypeInfo)]
269269
#[debug_with_type_info(bms_display_path = "bevy_mod_scripting_display")]
270270
pub struct AppScriptFunctionRegistry(pub ScriptFunctionRegistryArc);

crates/bevy_mod_scripting_bindings/src/reference.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -354,11 +354,11 @@ impl ReflectReference {
354354
})?
355355
}
356356

357-
/// Attempts to create a [`Box<dyn PartialReflect>`] from the reference. This is possible using a few strategies:
358-
/// - If the reference is to a world, a [`WorldCallbackAccess`] is created and boxed
357+
/// Attempts to create a `Box<dyn PartialReflect>` from the reference. This is possible using a few strategies:
358+
/// - If the reference is to a world, a [`crate::world::WorldCallbackAccess`] is created and boxed
359359
/// - If the reference is to an allocation with no reflection path and references to it, the value is taken as is.
360-
/// - If the reference has a [`bevy::reflect::ReflectFromReflect`] type data associated with it, the value is cloned using that impl.
361-
/// - If all above fails, [`bevy::reflect::PartialReflect::clone_value`] is used to clone the value.
360+
/// - If the reference has a [`bevy_reflect::ReflectFromReflect`] type data associated with it, the value is cloned using that impl.
361+
/// - If all above fails, [`bevy_reflect::PartialReflect::clone_value`] is used to clone the value.
362362
///
363363
pub fn to_owned_value(
364364
&self,
@@ -466,7 +466,7 @@ impl ReflectReference {
466466
/// - The caller must ensure the cell has permission to access the underlying value
467467
/// - The caller must ensure no aliasing references to the same value exist at all at the same time
468468
///
469-
/// To do this safely you need to use [`WorldAccessGuard::claim_read_access`] or [`WorldAccessGuard::claim_global_access`] to ensure nobody else is currently accessing the value.
469+
/// To do this safely you need to use [`crate::world::WorldAccessGuard::claim_read_access`] or [`crate::world::WorldAccessGuard::claim_global_access`] to ensure nobody else is currently accessing the value.
470470
pub unsafe fn reflect_unsafe<'w>(
471471
&self,
472472
world: WorldGuard<'w>,
@@ -527,7 +527,7 @@ impl ReflectReference {
527527
/// - The caller must ensure the cell has permission to access the underlying value
528528
/// - The caller must ensure no other references to the same value exist at all at the same time (even if you have the correct access)
529529
///
530-
/// To do this safely you need to use [`WorldAccessGuard::claim_write_access`] or [`WorldAccessGuard::claim_global_access`] to ensure nobody else is currently accessing the value.
530+
/// To do this safely you need to use [`crate::world::WorldAccessGuard::claim_write_access`] or [`crate::world::WorldAccessGuard::claim_global_access`] to ensure nobody else is currently accessing the value.
531531
pub unsafe fn reflect_mut_unsafe<'w>(
532532
&self,
533533
world: WorldGuard<'w>,

crates/bevy_mod_scripting_bindings/src/world.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ pub type WorldGuard<'w> = WorldAccessGuard<'w>;
6969
/// Similar to [`WorldGuard`], but without the arc, use for when you don't need the outer Arc.
7070
pub type WorldGuardRef<'w> = &'w WorldAccessGuard<'w>;
7171

72-
/// Provides safe access to the world via [`WorldAccess`] permissions, which enforce aliasing rules at runtime in multi-thread environments
72+
/// Provides safe access to the world via [`AnyAccessMap`] permissions, which enforce aliasing rules at runtime in multi-thread environments
7373
#[derive(Clone, Debug)]
7474
pub struct WorldAccessGuard<'w> {
7575
/// The guard this guard pointer represents

crates/bevy_mod_scripting_core/src/commands.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ impl<P: IntoScriptPluginParams> RunScriptCallback<P> {
108108
result
109109
}
110110

111-
/// Equivalent to [`Self::run`], but usable in the case where you already have a [`HandlerContext`].
111+
/// Equivalent to [`Self::run`], but usable in the case where you already have [`ScriptContext`] and [`ScriptCallbacks`] resources available.
112112
pub fn run_with_contexts(
113113
self,
114114
guard: WorldGuard,

crates/bevy_mod_scripting_core/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ pub enum ScriptingSystemSet {
6464
///
6565
/// When implementing a new scripting plugin, also ensure the following implementations exist:
6666
/// - [`Plugin`] for the plugin, both [`Plugin::build`] and [`Plugin::finish`] methods need to be dispatched to the underlying [`ScriptingPlugin`] struct
67-
/// - [`AsMut<ScriptingPlugin<Self>`] for the plugin struct
67+
/// - [`AsMut<ScriptingPlugin<Self>>`] for the plugin struct
6868
pub trait IntoScriptPluginParams: 'static + GetPluginThreadConfig<Self> {
6969
/// The language of the scripts
7070
const LANGUAGE: Language;

crates/bevy_mod_scripting_core/src/pipeline/mod.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,17 @@ pub enum PipelineSet {
4848

4949
/// A pipeline plugin which enables the loading and unloading of scripts in a highly modular way
5050
pub struct ScriptLoadingPipeline<P: IntoScriptPluginParams> {
51-
/// by default the plugin will listen to [`ScriptComponent`] attachments/detachments and synchronize scripts accordingly,
51+
/// by default the plugin will listen to [`crate::ScriptComponent`] attachments/detachments and synchronize scripts accordingly,
5252
/// you can opt out of this behavior by disabling this flag.
5353
pub script_component_triggers: bool,
54-
/// by default the plugin will listen to [`AssetEvent<ScriptAsset>`] events, and trigger the pipeline on asset modifications.
54+
/// by default the plugin will listen to [`bevy_asset::AssetEvent<ScriptAsset>`] events, and trigger the pipeline on asset modifications.
5555
pub hot_loading_asset_triggers: bool,
5656

57-
/// If true the [`OnScriptLoaded`] callback will be triggered when loading scripts
57+
/// If true the [`crate::event::OnScriptLoaded`] callback will be triggered when loading scripts
5858
pub on_script_loaded_callback: bool,
59-
/// If true the [`OnScriptReloaded`] callback will be triggered when loading scripts
59+
/// If true the [`crate::event::OnScriptReloaded`] callback will be triggered when loading scripts
6060
pub on_script_reloaded_callback: bool,
61-
/// If true the [`OnScriptUnloaded`] callback will be triggered when loading scripts
61+
/// If true the [`crate::event::OnScriptUnloaded`] callback will be triggered when loading scripts
6262
pub on_script_unloaded_callback: bool,
6363
_ph: PhantomData<fn(P)>,
6464

0 commit comments

Comments
 (0)