Skip to content

Commit 20c85b5

Browse files
authored
Bevy Input Docs : the modules (#9467)
# Objective Complete the documentation of `bevy_input` (#3492). This PR is part of a triptych of PRs : - #9468 - #9469 ## Solution Add documentation on modules in `bevy_input`.
1 parent 427ba30 commit 20c85b5

File tree

8 files changed

+22
-0
lines changed

8 files changed

+22
-0
lines changed

crates/bevy_input/src/axis.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! The generic axis type.
2+
13
use bevy_ecs::system::Resource;
24
use bevy_utils::HashMap;
35
use std::hash::Hash;

crates/bevy_input/src/gamepad.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! The gamepad input functionality.
2+
13
use crate::{Axis, ButtonState, Input};
24
use bevy_ecs::event::{Event, EventReader, EventWriter};
35
use bevy_ecs::{

crates/bevy_input/src/input.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! The generic input type.
2+
13
use bevy_ecs::system::Resource;
24
use bevy_reflect::{std_traits::ReflectDefault, Reflect};
35
use bevy_utils::HashSet;

crates/bevy_input/src/keyboard.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! The keyboard input functionality.
2+
13
use crate::{ButtonState, Input};
24
use bevy_ecs::entity::Entity;
35
use bevy_ecs::{

crates/bevy_input/src/lib.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
#![allow(clippy::type_complexity)]
2+
#![warn(missing_docs)]
3+
4+
//! Input functionality for the [Bevy game engine](https://bevyengine.org/).
5+
//!
6+
//! # Supported input devices
7+
//!
8+
//! `bevy` currently supports keyboard, mouse, gamepad, and touch inputs.
29
310
mod axis;
411
/// Common run conditions
@@ -13,6 +20,7 @@ pub mod touchpad;
1320
pub use axis::*;
1421
pub use input::*;
1522

23+
/// Most commonly used re-exported types.
1624
pub mod prelude {
1725
#[doc(hidden)]
1826
pub use crate::{

crates/bevy_input/src/mouse.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! The mouse input functionality.
2+
13
use crate::{ButtonState, Input};
24
use bevy_ecs::entity::Entity;
35
use bevy_ecs::{

crates/bevy_input/src/touch.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! The touch input functionality.
2+
13
use bevy_ecs::event::{Event, EventReader};
24
use bevy_ecs::system::{ResMut, Resource};
35
use bevy_math::Vec2;

crates/bevy_input/src/touchpad.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! The touchpad input functionality.
2+
13
use bevy_ecs::event::Event;
24
use bevy_reflect::Reflect;
35

0 commit comments

Comments
 (0)