Skip to content

Commit b97ae34

Browse files
authored
Try #2577:
2 parents 43d99bb + 83bec18 commit b97ae34

File tree

5 files changed

+17
-12
lines changed

5 files changed

+17
-12
lines changed

crates/bevy_app/src/app.rs

+8-5
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ impl App {
343343
/// A resource in Bevy represents globally unique data. Resources must be added to Bevy Apps
344344
/// before using them. This happens with [`App::insert_resource`].
345345
///
346-
/// See also `init_resource` for resources that implement `Default` or [`FromResources`].
346+
/// See also `init_resource` for resources that implement `Default` or [`FromWorld`].
347347
///
348348
/// ## Example
349349
/// ```
@@ -390,7 +390,7 @@ impl App {
390390

391391
/// Initialize a resource in the current [App], if it does not exist yet
392392
///
393-
/// Adds a resource that implements `Default` or [`FromResources`] trait.
393+
/// Adds a resource that implements `Default` or [`FromWorld`] trait.
394394
/// If the resource already exists, `init_resource` does nothing.
395395
///
396396
/// ## Example
@@ -440,8 +440,9 @@ impl App {
440440

441441
/// Sets the main runner loop function for this Bevy App
442442
///
443-
/// Usually the main loop is handled by Bevy integrated plugins ([`WinitPlugin`]), but
444-
/// in some cases one might wish to implement their own main loop.
443+
/// Usually the main loop is handled by Bevy integrated plugins
444+
/// ([`WinitPlugin`](https://docs.rs/bevy_winit/0.5.0/bevy_winit/struct.WinitPlugin.html)),
445+
/// but in some cases one might wish to implement their own main loop.
445446
///
446447
/// This method sets the main loop function, overwriting a previous runner if any.
447448
///
@@ -491,7 +492,9 @@ impl App {
491492
/// Bevy plugins can be grouped into a set of plugins. Bevy provides
492493
/// built-in PluginGroups that provide core engine functionality.
493494
///
494-
/// The plugin groups available by default are [`DefaultPlugins`] and [`MinimalPlugins`].
495+
/// The plugin groups available by default are
496+
/// [`DefaultPlugins`](https://docs.rs/bevy_internal/0.5.0/bevy_internal/struct.DefaultPlugins.html)
497+
/// and [`MinimalPlugins`](https://docs.rs/bevy_internal/0.5.0/bevy_internal/struct.MinimalPlugins.html).
495498
///
496499
/// ## Example
497500
/// ```

crates/bevy_asset/src/asset_server.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,8 @@ impl AssetServer {
221221
/// The absolute Path to the asset is "ROOT/ASSET_FOLDER_NAME/path".
222222
///
223223
/// By default the ROOT is the directory of the Application, but this can be overridden by
224-
/// setting the `"CARGO_MANIFEST_DIR"` environment variable (see https://doc.rust-lang.org/cargo/reference/environment-variables.html)
224+
/// setting the `"CARGO_MANIFEST_DIR"` environment variable
225+
/// (see <https://doc.rust-lang.org/cargo/reference/environment-variables.html>)
225226
/// to another directory. When the application is run through Cargo, then
226227
/// `"CARGO_MANIFEST_DIR"` is automatically set to the root folder of your crate (workspace).
227228
///

crates/bevy_ecs/src/bundle.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ use std::{any::TypeId, collections::HashMap};
3838
/// ```
3939
///
4040
/// # Safety
41-
/// [Bundle::component_id] must return the ComponentId for each component type in the bundle, in the
41+
/// [Bundle::component_ids] must return the ComponentId for each component type in the bundle, in the
4242
/// _exact_ order that [Bundle::get_components] is called.
4343
/// [Bundle::from_components] must call `func` exactly once for each [ComponentId] returned by
44-
/// [Bundle::component_id]
44+
/// [Bundle::component_ids]
4545
pub unsafe trait Bundle: Send + Sync + 'static {
4646
/// Gets this [Bundle]'s component ids, in the order of this bundle's Components
4747
fn component_ids(components: &mut Components) -> Vec<ComponentId>;

crates/bevy_ecs/src/change_detection.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ impl_debug!(ResMut<'a, T>, Component);
152152

153153
/// Unique borrow of a non-[`Send`] resource.
154154
///
155-
/// Only [`Send`] resources may be accessed with the [`ResMut`] [`SystemParam`]. In case that the
155+
/// Only [`Send`] resources may be accessed with the [`ResMut`] [`crate::system::SystemParam`]. In case that the
156156
/// resource does not implement `Send`, this `SystemParam` wrapper can be used. This will instruct
157157
/// the scheduler to instead run the system on the main thread so that it doesn't send the resource
158158
/// over to another thread.

crates/bevy_pbr/src/material.rs

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use bevy_reflect::TypeUuid;
33
use bevy_render::{color::Color, renderer::RenderResources, shader::ShaderDefs, texture::Texture};
44

55
/// A material with "standard" properties used in PBR lighting
6-
/// Standard property values with pictures here https://google.github.io/filament/Material%20Properties.pdf
6+
/// Standard property values with pictures here <https://google.github.io/filament/Material%20Properties.pdf>
77
#[derive(Debug, RenderResources, ShaderDefs, TypeUuid)]
88
#[uuid = "dace545e-4bc6-4595-a79d-c224fc694975"]
99
pub struct StandardMaterial {
@@ -50,7 +50,7 @@ impl Default for StandardMaterial {
5050
base_color: Color::rgb(1.0, 1.0, 1.0),
5151
base_color_texture: None,
5252
// This is the minimum the roughness is clamped to in shader code
53-
// See https://google.github.io/filament/Filament.html#materialsystem/parameterization/
53+
// See <https://google.github.io/filament/Filament.html#materialsystem/parameterization/>
5454
// It's the minimum floating point value that won't be rounded down to 0 in the
5555
// calculations used. Although technically for 32-bit floats, 0.045 could be
5656
// used.
@@ -59,7 +59,8 @@ impl Default for StandardMaterial {
5959
// This is just a default for mostly-dielectric
6060
metallic: 0.01,
6161
// Minimum real-world reflectance is 2%, most materials between 2-5%
62-
// Expressed in a linear scale and equivalent to 4% reflectance see https://google.github.io/filament/Material%20Properties.pdf
62+
// Expressed in a linear scale and equivalent to 4% reflectance see
63+
/// <https://google.github.io/filament/Material%20Properties.pdf>
6364
metallic_roughness_texture: None,
6465
reflectance: 0.5,
6566
normal_map: None,

0 commit comments

Comments
 (0)