Skip to content

Commit cd688d7

Browse files
fix rustdoc warnings (bevyengine#1437)
Every warning is fixed except for https://github.com/bevyengine/bevy/blob/b39df9a8d27076a8181c813b38e85833ad713be4/crates/bevy_render/src/texture/texture_descriptor.rs#L61 because I didn't know what the required feature is. I opened gfx-rs/wgpu#1213 for that.
1 parent d85b89b commit cd688d7

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

crates/bevy_ecs/src/core/access.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ impl QueryAccess {
212212
}
213213
}
214214

215-
/// Provides information about the types a [System] reads and writes
215+
/// Provides information about the types a [System](crate::System) reads and writes
216216
#[derive(Debug, Eq, PartialEq, Clone)]
217217
pub struct TypeAccess<T: Hash + Eq + PartialEq> {
218218
reads_all: bool,

crates/bevy_ecs/src/system/query/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use crate::{
88
use bevy_tasks::ParallelIterator;
99
use std::marker::PhantomData;
1010

11-
/// Provides scoped access to a World according to a given [HecsQuery]
11+
/// Provides scoped access to a World according to a given [WorldQuery]
1212
#[derive(Debug)]
1313
pub struct Query<'a, Q: WorldQuery, F: QueryFilter = ()> {
1414
pub(crate) world: &'a World,

crates/bevy_reflect/src/list.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use std::any::Any;
22

33
use crate::{serde::Serializable, Reflect, ReflectMut, ReflectRef};
44

5-
/// An ordered, mutable list of [ReflectValue] items. This corresponds to types like [std::vec::Vec].
5+
/// An ordered, mutable list of [Reflect] items. This corresponds to types like [std::vec::Vec].
66
pub trait List: Reflect {
77
fn get(&self, index: usize) -> Option<&dyn Reflect>;
88
fn get_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>;

crates/bevy_render/src/camera/visible_entities.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ pub type Layer = u8;
3434
/// Cameras with this component will only render entities with intersecting
3535
/// layers.
3636
///
37-
/// There are 32 layers numbered `0` - [`TOTAL_LAYERS`]. Entities may belong to one or more
37+
/// There are 32 layers numbered `0` - [`TOTAL_LAYERS`](RenderLayers::TOTAL_LAYERS). Entities may belong to one or more
3838
/// layers, or no layer at all.
3939
///
4040
/// The [`Default`] instance of `RenderLayers` contains layer `0`, the first layer.

crates/bevy_render/src/pipeline/binding.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ pub enum BindType {
3636
/// A filtering sampler can only be used with a filterable texture.
3737
filtering: bool,
3838
/// Use as a comparison sampler instead of a normal sampler.
39-
/// For more info take a look at the analogous functionality in OpenGL: https://www.khronos.org/opengl/wiki/Sampler_Object#Comparison_mode.
39+
/// For more info take a look at the analogous functionality in OpenGL: <https://www.khronos.org/opengl/wiki/Sampler_Object#Comparison_mode>.
4040
comparison: bool,
4141
},
4242
Texture {

crates/bevy_winit/src/winit_config.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ pub struct WinitConfig {
44
/// Configures the winit library to return control to the main thread after
55
/// the [run](bevy_app::App::run) loop is exited. Winit strongly recommends
66
/// avoiding this when possible. Before using this please read and understand
7-
/// the [caveats](winit::platform::desktop::EventLoopExtDesktop::run_return)
7+
/// the [caveats](winit::platform::run_return::EventLoopExtRunReturn::run_return)
88
/// in the winit documentation.
99
///
1010
/// This feature is only available on desktop `target_os` configurations.

0 commit comments

Comments
 (0)