From 01dd2001525850ef0d66374c69e98e1560cb6421 Mon Sep 17 00:00:00 2001 From: Thierry Berger Date: Fri, 12 Jul 2024 16:29:22 +0200 Subject: ci: cargo doc step (#671) --- src/geometry/collider.rs | 5 +++-- src/geometry/contact_pair.rs | 3 +++ src/geometry/narrow_phase.rs | 4 ++-- 3 files changed, 8 insertions(+), 4 deletions(-) (limited to 'src/geometry') diff --git a/src/geometry/collider.rs b/src/geometry/collider.rs index d72e098..1ceab43 100644 --- a/src/geometry/collider.rs +++ b/src/geometry/collider.rs @@ -622,8 +622,9 @@ impl ColliderBuilder { /// Initialize a new collider builder with a capsule defined from its endpoints. /// - /// See also [`ColliderBuilder::capsule_x`], [`ColliderBuilder::capsule_y`], and - /// [`ColliderBuilder::capsule_z`], for a simpler way to build capsules with common + /// See also [`ColliderBuilder::capsule_x`], [`ColliderBuilder::capsule_y`], + /// (and `ColliderBuilder::capsule_z` in 3D only) + /// for a simpler way to build capsules with common /// orientations. pub fn capsule_from_endpoints(a: Point, b: Point, radius: Real) -> Self { Self::new(SharedShape::capsule(a, b, radius)) diff --git a/src/geometry/contact_pair.rs b/src/geometry/contact_pair.rs index 8ff5dd6..3d4e955 100644 --- a/src/geometry/contact_pair.rs +++ b/src/geometry/contact_pair.rs @@ -7,6 +7,9 @@ use parry::query::ContactManifoldsWorkspace; use super::CollisionEvent; +#[cfg(doc)] +use super::Collider; + bitflags::bitflags! { #[cfg_attr(feature = "serde-serialize", derive(Serialize, Deserialize))] #[derive(Copy, Clone, PartialEq, Eq, Debug)] diff --git a/src/geometry/narrow_phase.rs b/src/geometry/narrow_phase.rs index 717fa25..e979a2f 100644 --- a/src/geometry/narrow_phase.rs +++ b/src/geometry/narrow_phase.rs @@ -108,7 +108,7 @@ impl NarrowPhase { /// All the contacts involving the given collider. /// - /// It is strongly recommended to use the [`NarrowPhase::contacts_with`] method instead. This + /// It is strongly recommended to use the [`NarrowPhase::contact_pairs_with`] method instead. This /// method can be used if the generation number of the collider handle isn't known. pub fn contact_pairs_with_unknown_gen( &self, @@ -141,7 +141,7 @@ impl NarrowPhase { /// All the intersection pairs involving the given collider. /// - /// It is strongly recommended to use the [`NarrowPhase::intersections_with`] method instead. + /// It is strongly recommended to use the [`NarrowPhase::intersection_pairs_with`] method instead. /// This method can be used if the generation number of the collider handle isn't known. pub fn intersection_pairs_with_unknown_gen( &self, -- cgit