From 20c85b5fc3764425018fc8535636b5c6224d4938 Mon Sep 17 00:00:00 2001
From: Tristan Guichaoua <33934311+tguichaoua@users.noreply.github.com>
Date: Wed, 23 Aug 2023 14:44:49 +0200
Subject: [PATCH] Bevy Input Docs : the modules (#9467)

# Objective

Complete the documentation of `bevy_input` (#3492).

This PR is part of a triptych of PRs :
- https://github.com/bevyengine/bevy/pull/9468
- https://github.com/bevyengine/bevy/pull/9469

## Solution

Add documentation on modules in `bevy_input`.
---
 crates/bevy_input/src/axis.rs     | 2 ++
 crates/bevy_input/src/gamepad.rs  | 2 ++
 crates/bevy_input/src/input.rs    | 2 ++
 crates/bevy_input/src/keyboard.rs | 2 ++
 crates/bevy_input/src/lib.rs      | 8 ++++++++
 crates/bevy_input/src/mouse.rs    | 2 ++
 crates/bevy_input/src/touch.rs    | 2 ++
 crates/bevy_input/src/touchpad.rs | 2 ++
 8 files changed, 22 insertions(+)

diff --git a/crates/bevy_input/src/axis.rs b/crates/bevy_input/src/axis.rs
index 895c35e04b44b..5fc3b787ae061 100644
--- a/crates/bevy_input/src/axis.rs
+++ b/crates/bevy_input/src/axis.rs
@@ -1,3 +1,5 @@
+//! The generic axis type.
+
 use bevy_ecs::system::Resource;
 use bevy_utils::HashMap;
 use std::hash::Hash;
diff --git a/crates/bevy_input/src/gamepad.rs b/crates/bevy_input/src/gamepad.rs
index 2cf6d1cbceef2..3e9857504c383 100644
--- a/crates/bevy_input/src/gamepad.rs
+++ b/crates/bevy_input/src/gamepad.rs
@@ -1,3 +1,5 @@
+//! The gamepad input functionality.
+
 use crate::{Axis, ButtonState, Input};
 use bevy_ecs::event::{Event, EventReader, EventWriter};
 use bevy_ecs::{
diff --git a/crates/bevy_input/src/input.rs b/crates/bevy_input/src/input.rs
index 3758840fecd65..803b740799f9a 100644
--- a/crates/bevy_input/src/input.rs
+++ b/crates/bevy_input/src/input.rs
@@ -1,3 +1,5 @@
+//! The generic input type.
+
 use bevy_ecs::system::Resource;
 use bevy_reflect::{std_traits::ReflectDefault, Reflect};
 use bevy_utils::HashSet;
diff --git a/crates/bevy_input/src/keyboard.rs b/crates/bevy_input/src/keyboard.rs
index edf291b6320d9..1c5648c7687ac 100644
--- a/crates/bevy_input/src/keyboard.rs
+++ b/crates/bevy_input/src/keyboard.rs
@@ -1,3 +1,5 @@
+//! The keyboard input functionality.
+
 use crate::{ButtonState, Input};
 use bevy_ecs::entity::Entity;
 use bevy_ecs::{
diff --git a/crates/bevy_input/src/lib.rs b/crates/bevy_input/src/lib.rs
index 07a9e384e09ac..7af8fec03add2 100644
--- a/crates/bevy_input/src/lib.rs
+++ b/crates/bevy_input/src/lib.rs
@@ -1,4 +1,11 @@
 #![allow(clippy::type_complexity)]
+#![warn(missing_docs)]
+
+//! Input functionality for the [Bevy game engine](https://bevyengine.org/).
+//!
+//! # Supported input devices
+//!
+//! `bevy` currently supports keyboard, mouse, gamepad, and touch inputs.
 
 mod axis;
 /// Common run conditions
@@ -13,6 +20,7 @@ pub mod touchpad;
 pub use axis::*;
 pub use input::*;
 
+/// Most commonly used re-exported types.
 pub mod prelude {
     #[doc(hidden)]
     pub use crate::{
diff --git a/crates/bevy_input/src/mouse.rs b/crates/bevy_input/src/mouse.rs
index deb8b8c4a03a1..062a1ed7647aa 100644
--- a/crates/bevy_input/src/mouse.rs
+++ b/crates/bevy_input/src/mouse.rs
@@ -1,3 +1,5 @@
+//! The mouse input functionality.
+
 use crate::{ButtonState, Input};
 use bevy_ecs::entity::Entity;
 use bevy_ecs::{
diff --git a/crates/bevy_input/src/touch.rs b/crates/bevy_input/src/touch.rs
index 64293b9d22426..f3660233e66b5 100644
--- a/crates/bevy_input/src/touch.rs
+++ b/crates/bevy_input/src/touch.rs
@@ -1,3 +1,5 @@
+//! The touch input functionality.
+
 use bevy_ecs::event::{Event, EventReader};
 use bevy_ecs::system::{ResMut, Resource};
 use bevy_math::Vec2;
diff --git a/crates/bevy_input/src/touchpad.rs b/crates/bevy_input/src/touchpad.rs
index 358c44585edbd..46105c9b866d3 100644
--- a/crates/bevy_input/src/touchpad.rs
+++ b/crates/bevy_input/src/touchpad.rs
@@ -1,3 +1,5 @@
+//! The touchpad input functionality.
+
 use bevy_ecs::event::Event;
 use bevy_reflect::Reflect;