Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-26 06:30:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add doc tests for the Size constructor functions (#7658)

Browse source 
# Objective

Add doc tests for the `Size` constructor functions.

Also changed the function descriptions so they explicitly state the values that elided values are given.

## Changelog
* Added doc tests for the `Size` constructor functions.
This commit is contained in:
ickshonpe 2023-02-13 18:20:34 +00:00
parent 14a7689e1a
commit 39bf45cf5e
1 changed files with 35 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
crates/bevy_ui/src/geometry.rs
View file

@ -358,6 +358,17 @@ impl Size {
}
/// Creates a new [`Size`] where both sides take the given value.
///
/// # Example
///
/// ```
/// # use bevy_ui::{Size, Val};
/// #
/// let size = Size::all(Val::Px(10.));
///
/// assert_eq!(size.width, Val::Px(10.0));
/// assert_eq!(size.height, Val::Px(10.0));
/// ```
pub const fn all(value: Val) -> Self {
Self {
width: value,
@ -365,7 +376,18 @@ impl Size {
}
}
/// Creates a new [`Size`] where `width` takes the given value.
/// Creates a new [`Size`] where `width` takes the given value and its `height` is `Val::Auto`.
///
/// # Example
///
/// ```
/// # use bevy_ui::{Size, Val};
/// #
/// let size = Size::width(Val::Px(10.));
///
/// assert_eq!(size.width, Val::Px(10.0));
/// assert_eq!(size.height, Val::Auto);
/// ```
pub const fn width(width: Val) -> Self {
Self {
width,
@ -373,7 +395,18 @@ impl Size {
}
}
/// Creates a new [`Size`] where `height` takes the given value.
/// Creates a new [`Size`] where `height` takes the given value and its `width` is `Val::Auto`.
///
/// # Example
///
/// ```
/// # use bevy_ui::{Size, Val};
/// #
/// let size = Size::height(Val::Px(10.));
///
/// assert_eq!(size.width, Val::Auto);
/// assert_eq!(size.height, Val::Px(10.));
/// ```
pub const fn height(height: Val) -> Self {
Self {
width: Val::Auto,