Skip to content

Minor doc fixes #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 28, 2024
Merged

Minor doc fixes #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use bevy::{
text::BreakLineOn,
};

/// A `Plugin` providing the systems and assets required to make a [`TextInputBundle`] work.
/// A Bevy `Plugin` providing the systems and assets required to make a [`TextInputBundle`] work.
pub struct TextInputPlugin;

impl Plugin for TextInputPlugin {
Expand Down Expand Up @@ -46,7 +46,7 @@ const CURSOR_HANDLE: Handle<Font> = Handle::weak_from_u128(10482756907980398621)

/// A bundle providing the additional components required for a text input.
///
/// Add this to a [`NodeBundle`].
/// Add this to a Bevy `NodeBundle`.
///
/// Examples:
/// ```rust
Expand All @@ -60,7 +60,7 @@ const CURSOR_HANDLE: Handle<Font> = Handle::weak_from_u128(10482756907980398621)
pub struct TextInputBundle {
/// A component containing the text input's settings.
pub settings: TextInputSettings,
/// A component containing the [`TextStyle`] that will be used when creating the text input's inner [`TextBundle`].
/// A component containing the Bevy `TextStyle` that will be used when creating the text input's inner Bevy `TextBundle`.
pub text_style: TextInputTextStyle,
/// A component containing a value indicating whether the text input is active or not.
pub inactive: TextInputInactive,
Expand All @@ -87,7 +87,7 @@ impl TextInputBundle {
self
}

/// Returns this [`TextInputBundle`] with a new [`TextInputTextStyle`] containing the provided `TextStyle`.
/// Returns this [`TextInputBundle`] with a new [`TextInputTextStyle`] containing the provided Bevy `TextStyle`.
pub fn with_text_style(mut self, text_style: TextStyle) -> Self {
self.text_style = TextInputTextStyle(text_style);
self
Expand All @@ -106,7 +106,7 @@ impl TextInputBundle {
}
}

/// The [`TextStyle`] that will be used when creating the text input's inner [`TextBundle`].
/// The Bevy `TextStyle` that will be used when creating the text input's inner Bevy `TextBundle`.
#[derive(Component, Default, Reflect)]
pub struct TextInputTextStyle(pub TextStyle);

Expand Down Expand Up @@ -158,7 +158,7 @@ pub struct TextInputSubmitEvent {
pub value: String,
}

/// A convenience parameter for dealing with a [`TextInput`]'s inner [`Text`] entity.
/// A convenience parameter for dealing with a text input's inner Bevy `Text` entity.
#[derive(SystemParam)]
struct InnerText<'w, 's> {
text_query: Query<'w, 's, &'static mut Text, With<TextInputInner>>,
Expand Down Expand Up @@ -372,7 +372,7 @@ fn create(
}
}

// Shows or hides the cursor based on the text input's `inactive` property.
// Shows or hides the cursor based on the text input's [`TextInputInactive`] property.
fn show_hide_cursor(
mut input_query: Query<
(
Expand Down