Skip to content

Commit

Permalink
fix rustdoc warnings (bevyengine#1437)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jakobhellermann committed Feb 22, 2021
1 parent d85b89b commit cd688d7
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion crates/bevy_ecs/src/core/access.rs
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ impl QueryAccess {
}
}

/// Provides information about the types a [System] reads and writes
/// Provides information about the types a [System](crate::System) reads and writes
#[derive(Debug, Eq, PartialEq, Clone)]
pub struct TypeAccess<T: Hash + Eq + PartialEq> {
reads_all: bool,
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_ecs/src/system/query/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use crate::{
use bevy_tasks::ParallelIterator;
use std::marker::PhantomData;

/// Provides scoped access to a World according to a given [HecsQuery]
/// Provides scoped access to a World according to a given [WorldQuery]
#[derive(Debug)]
pub struct Query<'a, Q: WorldQuery, F: QueryFilter = ()> {
pub(crate) world: &'a World,
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_reflect/src/list.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use std::any::Any;

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

/// An ordered, mutable list of [ReflectValue] items. This corresponds to types like [std::vec::Vec].
/// An ordered, mutable list of [Reflect] items. This corresponds to types like [std::vec::Vec].
pub trait List: Reflect {
fn get(&self, index: usize) -> Option<&dyn Reflect>;
fn get_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>;
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_render/src/camera/visible_entities.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ pub type Layer = u8;
/// Cameras with this component will only render entities with intersecting
/// layers.
///
/// There are 32 layers numbered `0` - [`TOTAL_LAYERS`]. Entities may belong to one or more
/// There are 32 layers numbered `0` - [`TOTAL_LAYERS`](RenderLayers::TOTAL_LAYERS). Entities may belong to one or more
/// layers, or no layer at all.
///
/// The [`Default`] instance of `RenderLayers` contains layer `0`, the first layer.
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_render/src/pipeline/binding.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pub enum BindType {
/// A filtering sampler can only be used with a filterable texture.
filtering: bool,
/// Use as a comparison sampler instead of a normal sampler.
/// For more info take a look at the analogous functionality in OpenGL: https://www.khronos.org/opengl/wiki/Sampler_Object#Comparison_mode.
/// For more info take a look at the analogous functionality in OpenGL: <https://www.khronos.org/opengl/wiki/Sampler_Object#Comparison_mode>.
comparison: bool,
},
Texture {
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_winit/src/winit_config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pub struct WinitConfig {
/// Configures the winit library to return control to the main thread after
/// the [run](bevy_app::App::run) loop is exited. Winit strongly recommends
/// avoiding this when possible. Before using this please read and understand
/// the [caveats](winit::platform::desktop::EventLoopExtDesktop::run_return)
/// the [caveats](winit::platform::run_return::EventLoopExtRunReturn::run_return)
/// in the winit documentation.
///
/// This feature is only available on desktop `target_os` configurations.
Expand Down

0 comments on commit cd688d7

Please sign in to comment.