diff --git a/src/api/call_fn.rs b/src/api/call_fn.rs index 33549155..6f72e1b7 100644 --- a/src/api/call_fn.rs +++ b/src/api/call_fn.rs @@ -86,7 +86,11 @@ impl Engine { /// /// Not available under `no_function`. /// - /// # WARNING + /// # WARNING - Low Level API + /// + /// This function is very low level. + /// + /// ## Arguments /// /// All the arguments are _consumed_, meaning that they're replaced by `()`. /// This is to avoid unnecessarily cloning the arguments. diff --git a/src/api/deprecated.rs b/src/api/deprecated.rs index 1d0f4a64..1bcd23b3 100644 --- a/src/api/deprecated.rs +++ b/src/api/deprecated.rs @@ -125,7 +125,11 @@ impl Engine { /// /// This method will be removed in the next major version. /// - /// # WARNING + /// # WARNING - Low Level API + /// + /// This function is very low level. + /// + /// ## Arguments /// /// All the arguments are _consumed_, meaning that they're replaced by `()`. /// This is to avoid unnecessarily cloning the arguments. @@ -221,7 +225,11 @@ impl Dynamic { impl NativeCallContext<'_> { /// Call a function inside the call context. /// - /// # WARNING + /// # WARNING - Low Level API + /// + /// This function is very low level. + /// + /// ## Arguments /// /// All arguments may be _consumed_, meaning that they may be replaced by `()`. This is to avoid /// unnecessarily cloning the arguments. @@ -273,7 +281,11 @@ impl FnPtr { /// /// This method will be removed in the next major version. /// - /// # WARNING + /// # WARNING - Low Level API + /// + /// This function is very low level. + /// + /// ## Arguments /// /// All the arguments are _consumed_, meaning that they're replaced by `()`. /// This is to avoid unnecessarily cloning the arguments. diff --git a/src/api/register.rs b/src/api/register.rs index 85288e00..a7f19301 100644 --- a/src/api/register.rs +++ b/src/api/register.rs @@ -154,7 +154,7 @@ impl Engine { /// /// This function is very low level. It takes a list of [`TypeId`][std::any::TypeId]'s indicating the actual types of the parameters. /// - /// # Arguments + /// ## Arguments /// /// Arguments are simply passed in as a mutable array of [`&mut Dynamic`][crate::Dynamic], /// The arguments are guaranteed to be of the correct types matching the [`TypeId`][std::any::TypeId]'s. diff --git a/src/func/native.rs b/src/func/native.rs index b0305cc7..e5cf5b8e 100644 --- a/src/func/native.rs +++ b/src/func/native.rs @@ -230,7 +230,11 @@ impl<'a> NativeCallContext<'a> { /// If `is_method_call` is [`true`], the first argument is assumed to be the `this` pointer for /// a script-defined function (or the object of a method call). /// - /// # WARNING + /// # WARNING - Low Level API + /// + /// This function is very low level. + /// + /// # Arguments /// /// All arguments may be _consumed_, meaning that they may be replaced by `()`. This is to avoid /// unnecessarily cloning the arguments. diff --git a/src/module/mod.rs b/src/module/mod.rs index 47d12f14..841c5d2b 100644 --- a/src/module/mod.rs +++ b/src/module/mod.rs @@ -741,7 +741,7 @@ impl Module { /// /// This function is very low level. /// - /// # Arguments + /// ## Arguments /// /// A list of [`TypeId`]'s is taken as the argument types. /// diff --git a/src/types/fn_ptr.rs b/src/types/fn_ptr.rs index e0476717..7475b7ef 100644 --- a/src/types/fn_ptr.rs +++ b/src/types/fn_ptr.rs @@ -204,7 +204,7 @@ impl FnPtr { /// /// This function is very low level. /// - /// # Arguments + /// ## Arguments /// /// All the arguments are _consumed_, meaning that they're replaced by `()`. /// This is to avoid unnecessarily cloning the arguments.