Skip to content

Commit

Permalink
Remove Transform links from doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Jondolf committed Jun 19, 2023
1 parent 21901b9 commit 62e8e95
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions src/plugins/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ use bevy::prelude::*;
/// - [`SolverPlugin`]: Solves positional and angular [constraints], updates velocities and solves velocity constraints
/// (dynamic [friction](Friction) and [restitution](Restitution)).
/// - [`SleepingPlugin`]: Controls when bodies should be deactivated and marked as [`Sleeping`] to improve performance.
/// - [`SyncPlugin`]: Synchronizes the engine's [`Position`]s and [`Rotation`]s with Bevy's [`Transform`]s.
/// - [`SyncPlugin`]: Synchronizes the engine's [`Position`]s and [`Rotation`]s with Bevy's `Transform`s.
/// - `PhysicsDebugPlugin`: Renders physics objects and events like [AABBs](ColliderAabb) and [contacts](Collision)
/// for debugging purposes (only with `debug-plugin` feature enabled).
///
Expand Down Expand Up @@ -185,7 +185,7 @@ pub enum PhysicsSet {
///
/// See [`SleepingPlugin`].
Sleeping,
/// Responsible for synchronizing [`Position`]s and [`Rotation`]s with Bevy's [`Transform`]s.
/// Responsible for synchronizing [`Position`]s and [`Rotation`]s with Bevy's `Transform`s.
///
/// See [`SyncPlugin`].
Sync,
Expand Down
10 changes: 5 additions & 5 deletions src/plugins/sync.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
//! Synchronizes the engine's [`Position`]s and [`Rotation`]s with Bevy's [`Transform`]s.
//! Synchronizes the engine's [`Position`]s and [`Rotation`]s with Bevy's `Transform`s.
//!
//! See [`SyncPlugin`].

use crate::{prelude::*, PhysicsSchedule};
use bevy::prelude::*;

/// Synchronizes the engine's [`Position`]s and [`Rotation`]s with Bevy's [`Transform`]s.
/// Synchronizes the engine's [`Position`]s and [`Rotation`]s with Bevy's `Transform`s.
///
/// Currently, the transforms of nested bodies are updated to reflect their global positions.
/// This means that nested [rigid bodies](RigidBody) can behave independently regardless of the hierarchy.
Expand All @@ -27,7 +27,7 @@ type RigidBodyParentComponents = (
Option<&'static Rotation>,
);

/// Copies [`Position`] and [`Rotation`] values from the physics world to Bevy [`Transform`]s.
/// Copies [`Position`] and [`Rotation`] values from the physics world to Bevy `Transform`s.
#[cfg(feature = "2d")]
fn sync_transforms(
mut bodies: Query<(&mut Transform, &Position, &Rotation, Option<&Parent>)>,
Expand Down Expand Up @@ -66,9 +66,9 @@ fn sync_transforms(
}
}

/// Copies [`Position`] and [`Rotation`] values from the physics world to Bevy's [`Transform`]s.
/// Copies [`Position`] and [`Rotation`] values from the physics world to Bevy's `Transform`s.
///
/// Nested rigid bodies move independently of each other, so the [`Transform`]s of child entities are updated
/// Nested rigid bodies move independently of each other, so the `Transform`s of child entities are updated
/// based on their own and their parent's [`Position`] and [`Rotation`].
#[cfg(feature = "3d")]
fn sync_transforms(
Expand Down

0 comments on commit 62e8e95

Please sign in to comment.