From eebcdb267100d32ac5228fe659e813631055a9cd Mon Sep 17 00:00:00 2001 From: Daniel Nelsen Date: Sat, 31 Jul 2021 11:16:06 -0700 Subject: [PATCH 1/3] Fix link warnings Made the links clickable by surrounding with <>, which should stop the warnings of "use an automatic link instead" --- crates/bevy_asset/src/asset_server.rs | 3 ++- crates/bevy_pbr/src/material.rs | 7 ++++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/crates/bevy_asset/src/asset_server.rs b/crates/bevy_asset/src/asset_server.rs index f46b96ed7bf8f6..777f815d0ea6eb 100644 --- a/crates/bevy_asset/src/asset_server.rs +++ b/crates/bevy_asset/src/asset_server.rs @@ -221,7 +221,8 @@ impl AssetServer { /// 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 (see https://doc.rust-lang.org/cargo/reference/environment-variables.html) + /// setting the `"CARGO_MANIFEST_DIR"` environment variable + /// (see ) /// to another directory. When the application is run through Cargo, then /// `"CARGO_MANIFEST_DIR"` is automatically set to the root folder of your crate (workspace). /// diff --git a/crates/bevy_pbr/src/material.rs b/crates/bevy_pbr/src/material.rs index 73c1f80ac6a4e2..63feb96ef01237 100644 --- a/crates/bevy_pbr/src/material.rs +++ b/crates/bevy_pbr/src/material.rs @@ -3,7 +3,7 @@ use bevy_reflect::TypeUuid; use bevy_render::{color::Color, renderer::RenderResources, shader::ShaderDefs, texture::Texture}; /// A material with "standard" properties used in PBR lighting -/// Standard property values with pictures here https://google.github.io/filament/Material%20Properties.pdf +/// Standard property values with pictures here #[derive(Debug, RenderResources, ShaderDefs, TypeUuid)] #[uuid = "dace545e-4bc6-4595-a79d-c224fc694975"] pub struct StandardMaterial { @@ -50,7 +50,7 @@ impl Default for StandardMaterial { base_color: Color::rgb(1.0, 1.0, 1.0), base_color_texture: None, // This is the minimum the roughness is clamped to in shader code - // See https://google.github.io/filament/Filament.html#materialsystem/parameterization/ + // See // It's the minimum floating point value that won't be rounded down to 0 in the // calculations used. Although technically for 32-bit floats, 0.045 could be // used. @@ -59,7 +59,8 @@ impl Default for StandardMaterial { // This is just a default for mostly-dielectric metallic: 0.01, // Minimum real-world reflectance is 2%, most materials between 2-5% - // Expressed in a linear scale and equivalent to 4% reflectance see https://google.github.io/filament/Material%20Properties.pdf + // Expressed in a linear scale and equivalent to 4% reflectance see + /// metallic_roughness_texture: None, reflectance: 0.5, normal_map: None, From 534fce7d1d8945d31f31d2fed83869ba57e9d18e Mon Sep 17 00:00:00 2001 From: Daniel Nelsen Date: Sat, 31 Jul 2021 11:45:50 -0700 Subject: [PATCH 2/3] Add external doc links This is by adding a link to the docs.rs pages for external structs. --- crates/bevy_app/src/app.rs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/crates/bevy_app/src/app.rs b/crates/bevy_app/src/app.rs index d4182205407884..bbd305da5cdc7b 100644 --- a/crates/bevy_app/src/app.rs +++ b/crates/bevy_app/src/app.rs @@ -440,8 +440,9 @@ impl App { /// Sets the main runner loop function for this Bevy App /// - /// Usually the main loop is handled by Bevy integrated plugins ([`WinitPlugin`]), but - /// in some cases one might wish to implement their own main loop. + /// Usually the main loop is handled by Bevy integrated plugins + /// ([`WinitPlugin`](https://docs.rs/bevy_winit/0.5.0/bevy_winit/struct.WinitPlugin.html)), + /// but in some cases one might wish to implement their own main loop. /// /// This method sets the main loop function, overwriting a previous runner if any. /// @@ -491,7 +492,9 @@ impl App { /// Bevy plugins can be grouped into a set of plugins. Bevy provides /// built-in PluginGroups that provide core engine functionality. /// - /// The plugin groups available by default are [`DefaultPlugins`] and [`MinimalPlugins`]. + /// The plugin groups available by default are + /// [`DefaultPlugins`](https://docs.rs/bevy_internal/0.5.0/bevy_internal/struct.DefaultPlugins.html) + /// and [`MinimalPlugins`](https://docs.rs/bevy_internal/0.5.0/bevy_internal/struct.MinimalPlugins.html). /// /// ## Example /// ``` From 83bec18c05f5dfa321648edd15bd8c56f40a1fc1 Mon Sep 17 00:00:00 2001 From: Daniel Nelsen Date: Sat, 31 Jul 2021 11:55:17 -0700 Subject: [PATCH 3/3] Fix intra doc links Fix links that are (theoritically) broken due to typos and refactoring. --- crates/bevy_app/src/app.rs | 4 ++-- crates/bevy_ecs/src/bundle.rs | 4 ++-- crates/bevy_ecs/src/change_detection.rs | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/crates/bevy_app/src/app.rs b/crates/bevy_app/src/app.rs index bbd305da5cdc7b..f0b0ff65a1344a 100644 --- a/crates/bevy_app/src/app.rs +++ b/crates/bevy_app/src/app.rs @@ -343,7 +343,7 @@ impl App { /// A resource in Bevy represents globally unique data. Resources must be added to Bevy Apps /// before using them. This happens with [`App::insert_resource`]. /// - /// See also `init_resource` for resources that implement `Default` or [`FromResources`]. + /// See also `init_resource` for resources that implement `Default` or [`FromWorld`]. /// /// ## Example /// ``` @@ -390,7 +390,7 @@ impl App { /// Initialize a resource in the current [App], if it does not exist yet /// - /// Adds a resource that implements `Default` or [`FromResources`] trait. + /// Adds a resource that implements `Default` or [`FromWorld`] trait. /// If the resource already exists, `init_resource` does nothing. /// /// ## Example diff --git a/crates/bevy_ecs/src/bundle.rs b/crates/bevy_ecs/src/bundle.rs index 2c38e249fb5ec2..9a9d71c5286ccc 100644 --- a/crates/bevy_ecs/src/bundle.rs +++ b/crates/bevy_ecs/src/bundle.rs @@ -38,10 +38,10 @@ use std::{any::TypeId, collections::HashMap}; /// ``` /// /// # Safety -/// [Bundle::component_id] must return the ComponentId for each component type in the bundle, in the +/// [Bundle::component_ids] must return the ComponentId for each component type in the bundle, in the /// _exact_ order that [Bundle::get_components] is called. /// [Bundle::from_components] must call `func` exactly once for each [ComponentId] returned by -/// [Bundle::component_id] +/// [Bundle::component_ids] pub unsafe trait Bundle: Send + Sync + 'static { /// Gets this [Bundle]'s component ids, in the order of this bundle's Components fn component_ids(components: &mut Components) -> Vec; diff --git a/crates/bevy_ecs/src/change_detection.rs b/crates/bevy_ecs/src/change_detection.rs index 7d27c2d9aad3e2..2ebd0a3ed56e9a 100644 --- a/crates/bevy_ecs/src/change_detection.rs +++ b/crates/bevy_ecs/src/change_detection.rs @@ -152,7 +152,7 @@ impl_debug!(ResMut<'a, T>, Component); /// Unique borrow of a non-[`Send`] resource. /// -/// Only [`Send`] resources may be accessed with the [`ResMut`] [`SystemParam`]. In case that the +/// Only [`Send`] resources may be accessed with the [`ResMut`] [`crate::system::SystemParam`]. In case that the /// resource does not implement `Send`, this `SystemParam` wrapper can be used. This will instruct /// the scheduler to instead run the system on the main thread so that it doesn't send the resource /// over to another thread.