From 4085e8559bb365572d888120f776c4261f16094a Mon Sep 17 00:00:00 2001 From: Bob Gardner Date: Mon, 3 Jun 2024 11:37:39 -0700 Subject: [PATCH] Better comments --- crates/bevy_math/src/compass.rs | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/crates/bevy_math/src/compass.rs b/crates/bevy_math/src/compass.rs index 87f4b21448c2e..95a0d19819896 100644 --- a/crates/bevy_math/src/compass.rs +++ b/crates/bevy_math/src/compass.rs @@ -5,8 +5,6 @@ use bevy_reflect::Reflect; use bevy_reflect::{ReflectDeserialize, ReflectSerialize}; /// A compass enum with 4 directions. -/// [`CompassQuadrant::North`] corresponds to [`Dir2::Y`] -/// [`CompassQuadrant::East`] corresponds to [`Dir2::X`] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))] #[cfg_attr(feature = "bevy_reflect", derive(Reflect), reflect(Debug, PartialEq))] @@ -15,15 +13,17 @@ use bevy_reflect::{ReflectDeserialize, ReflectSerialize}; reflect(Deserialize, Serialize) )] pub enum CompassQuadrant { + /// Corresponds to [`Dir2::Y`] and [`Dir2::NORTH`] North, + /// Corresponds to [`Dir2::X`] and [`Dir2::EAST`] East, + /// Corresponds to [`Dir2::NEG_X`] and [`Dir2::SOUTH`] South, + /// Corresponds to [`Dir2::NEG_Y`] and [`Dir2::WEST`] West, } /// A compass enum with 8 directions. -/// [`CompassQuadrant::North`] corresponds to [`Dir2::Y`] -/// [`CompassQuadrant::East`] corresponds to [`Dir2::X`] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))] #[cfg_attr(feature = "bevy_reflect", derive(Reflect), reflect(Debug, PartialEq))] @@ -32,13 +32,21 @@ pub enum CompassQuadrant { reflect(Deserialize, Serialize) )] pub enum CompassOctant { + /// Corresponds to [`Dir2::Y`] and [`Dir2::NORTH`] North, + /// Corresponds to [`Dir2::NORTH_EAST`] NorthEast, + /// Corresponds to [`Dir2::X`] and [`Dir2::EAST`] East, + /// Corresponds to [`Dir2::SOUTH_EAST`] SouthEast, + /// Corresponds to [`Dir2::NEG_X`] and [`Dir2::SOUTH`] South, + /// Corresponds to [`Dir2::SOUTH_WEST`] SouthWest, + /// Corresponds to [`Dir2::NEG_Y`] and [`Dir2::WEST`] West, + /// Corresponds to [`Dir2::NORTH_WEST`] NorthWest, }