Skip to content

Commit

Permalink
Made a doc alias of "plane" for vector reject from.
Browse files Browse the repository at this point in the history
  • Loading branch information
bitshifter committed Jul 15, 2024
1 parent d4f407a commit b66b7f9
Show file tree
Hide file tree
Showing 16 changed files with 32 additions and 0 deletions.
2 changes: 2 additions & 0 deletions codegen/templates/vec.rs.tera
Original file line number Diff line number Diff line change
Expand Up @@ -1640,6 +1640,7 @@ impl {{ self_t }} {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -1670,6 +1671,7 @@ impl {{ self_t }} {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/coresimd/vec3a.rs
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,7 @@ impl Vec3A {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -617,6 +618,7 @@ impl Vec3A {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/coresimd/vec4.rs
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,7 @@ impl Vec4 {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -598,6 +599,7 @@ impl Vec4 {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/neon/vec3a.rs
Original file line number Diff line number Diff line change
Expand Up @@ -631,6 +631,7 @@ impl Vec3A {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -661,6 +662,7 @@ impl Vec3A {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/neon/vec4.rs
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,7 @@ impl Vec4 {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -632,6 +633,7 @@ impl Vec4 {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/scalar/vec3a.rs
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,7 @@ impl Vec3A {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -640,6 +641,7 @@ impl Vec3A {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/scalar/vec4.rs
Original file line number Diff line number Diff line change
Expand Up @@ -657,6 +657,7 @@ impl Vec4 {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -687,6 +688,7 @@ impl Vec4 {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/sse2/vec3a.rs
Original file line number Diff line number Diff line change
Expand Up @@ -630,6 +630,7 @@ impl Vec3A {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -660,6 +661,7 @@ impl Vec3A {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/sse2/vec4.rs
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,7 @@ impl Vec4 {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -640,6 +641,7 @@ impl Vec4 {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/vec2.rs
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,7 @@ impl Vec2 {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -572,6 +573,7 @@ impl Vec2 {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/vec3.rs
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,7 @@ impl Vec3 {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -630,6 +631,7 @@ impl Vec3 {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/wasm32/vec3a.rs
Original file line number Diff line number Diff line change
Expand Up @@ -598,6 +598,7 @@ impl Vec3A {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -628,6 +629,7 @@ impl Vec3A {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f32/wasm32/vec4.rs
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,7 @@ impl Vec4 {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -615,6 +616,7 @@ impl Vec4 {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f64/dvec2.rs
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,7 @@ impl DVec2 {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -572,6 +573,7 @@ impl DVec2 {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f64/dvec3.rs
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,7 @@ impl DVec3 {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -630,6 +631,7 @@ impl DVec3 {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down
2 changes: 2 additions & 0 deletions src/f64/dvec4.rs
Original file line number Diff line number Diff line change
Expand Up @@ -646,6 +646,7 @@ impl DVec4 {
/// # Panics
///
/// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from(self, rhs: Self) -> Self {
Expand Down Expand Up @@ -676,6 +677,7 @@ impl DVec4 {
/// # Panics
///
/// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
#[doc(alias("plane"))]
#[inline]
#[must_use]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
Expand Down

0 comments on commit b66b7f9

Please sign in to comment.