Skip to content

Commit

Permalink
Fix cargo doc warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
keis committed Oct 17, 2023
1 parent fa4452f commit e91dc4c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
3 changes: 1 addition & 2 deletions backends/bevy_picking_raycast/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ pub struct RaycastBackendSettings {
}

/// This unit struct is used to tag the generic ray casting types
/// [`RaycastMesh`](bevy_mod_raycast::RaycastMesh) and
/// [`RaycastSource`](bevy_mod_raycast::RaycastSource).
/// [`RaycastMesh`] and [`RaycastSource`].
#[derive(Reflect, Clone)]
pub struct RaycastPickingSet;

Expand Down
14 changes: 7 additions & 7 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@
//!
//! #### Backend ([`bevy_picking_core::backend`])
//!
//! A picking backend only has one job: reading [`PointerLocation`](crate::pointer::PointerLocation)
//! components, and producing [`PointerHits`](crate::backend::PointerHits).
//! A picking backend only has one job: reading [`PointerLocation`] components, and producing
//! [`PointerHits`](crate::backend::PointerHits).
//!
//! You will eventually need to choose which picking backend(s) you want to use. This plugin uses
//! `bevy_mod_raycast` by default; it works with bevy `Mesh`es out of the box and requires no extra
Expand All @@ -148,9 +148,9 @@
//! just because a pointer is over an entity, it is not necessarily hovering that entity. Although
//! multiple backends may be reporting that a pointer is over an entity, the focus system needs to
//! determine which one(s) are actually being hovered based on the pick depth, order of the backend,
//! and the [`Pickable`](bevy_picking_core::Pickable) state of the entity. In other words, if one
//! entity is in front of another, only the topmost one will be hovered, even if the pointer is
//! within the bounds of both entities.
//! and the [`Pickable`] state of the entity. In other words, if one entity is in front of another,
//! only the topmost one will be hovered, even if the pointer is within the bounds of both
//! entities.
//!
//! #### Events ([`bevy_picking_core::events`])
//!
Expand Down Expand Up @@ -244,10 +244,10 @@ pub struct PickableBundle {
pub pickable: Pickable,
/// Tracks entity interaction state.
pub interaction: focus::PickingInteraction,
/// Tracks entity [`PickSelection`](selection::PickSelection) state.
/// Tracks entity [`PickSelection`] state.
#[cfg(feature = "selection")]
pub selection: selection::PickSelection,
/// Tracks entity [`PickHighlight`](highlight::PickHighlight) state.
/// Tracks entity [`PickHighlight`] state.
#[cfg(feature = "highlight")]
pub highlight: highlight::PickHighlight,
}
Expand Down

0 comments on commit e91dc4c

Please sign in to comment.