Skip to content

Commit 69084cf

Browse files
committed
Improve docs
1 parent 9003e9f commit 69084cf

File tree

3 files changed

+6
-1
lines changed

3 files changed

+6
-1
lines changed

src/collider_tree/mod.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ use core::marker::PhantomData;
4141
use crate::prelude::*;
4242
use bevy::prelude::*;
4343

44-
/// A plugin that manages [`ColliderTrees`] for a collider type `C`.
44+
/// A plugin that manages [collider trees](crate::collider_tree) for a collider type `C`.
4545
pub struct ColliderTreePlugin<C: AnyCollider>(PhantomData<C>);
4646

4747
impl<C: AnyCollider> Default for ColliderTreePlugin<C> {
@@ -110,6 +110,8 @@ pub enum ColliderTreeSystems {
110110
}
111111

112112
/// Trees for accelerating queries on a set of colliders.
113+
///
114+
/// See the [`collider_tree`](crate::collider_tree) module for more information.
113115
#[derive(Resource, Default)]
114116
pub struct ColliderTrees {
115117
/// A tree for the colliders of dynamic bodies.

src/collider_tree/tree.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ use crate::{
2020

2121
/// A [Bounding Volume Hierarchy (BVH)][BVH] for accelerating queries on a set of colliders.
2222
///
23+
/// See the [`collider_tree`](crate::collider_tree) module for more information.
24+
///
2325
/// [BVH]: https://en.wikipedia.org/wiki/Bounding_volume_hierarchy
2426
#[derive(Clone, Default)]
2527
pub struct ColliderTree {

src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -621,6 +621,7 @@ use prelude::*;
621621
/// | [`PhysicsDiagnosticsPlugin`] | Writes [physics diagnostics](diagnostics) to the [`DiagnosticsStore`] (only with `bevy_diagnostic` feature enabled). |
622622
/// | [`PhysicsDiagnosticsUiPlugin`] | Displays [physics diagnostics](diagnostics) with a debug UI overlay (only with `diagnostic_ui` feature enabled). |
623623
///
624+
/// [`ColliderTrees`]: collider_tree::ColliderTrees
624625
/// [broad phase]: collision::broad_phase
625626
/// [BVH]: https://en.wikipedia.org/wiki/Bounding_volume_hierarchy
626627
/// [`DiagnosticsStore`]: bevy::diagnostic::DiagnosticsStore

0 commit comments

Comments
 (0)