forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Finish documenting bevy_gilrs (#10010)

Browse Source 
# Objective

Finish documenting `bevy_gilrs`.

## Solution

Document the remaining items, add a `warn(missing_docs)` attribute for
the crate.
This commit is contained in:
Kanabenki 2023-10-04 23:10:20 +02:00 committed by GitHub
parent 9086e60c20
commit 86f7ef1bd7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
clippy.toml
View File

@ -1 +1 @@
doc-valid-idents = ["sRGB", "NaN", "iOS", "glTF", "GitHub", "WebGPU"] doc-valid-idents = ["sRGB", "NaN", "iOS", "glTF", "GitHub", "WebGPU", "GilRs"]

7
crates/bevy_gilrs/src/lib.rs
View File

@ -1,4 +1,10 @@
//! Systems and type definitions for gamepad handling in Bevy.
//!
//! This crate is built on top of [GilRs](gilrs), a library
//! that handles abstracting over platform-specific gamepad APIs.
#![allow(clippy::type_complexity)] #![allow(clippy::type_complexity)]
#![warn(missing_docs)]
mod converter; mod converter;
mod gilrs_system; mod gilrs_system;
@ -12,6 +18,7 @@ use gilrs::GilrsBuilder;
use gilrs_system::{gilrs_event_startup_system, gilrs_event_system}; use gilrs_system::{gilrs_event_startup_system, gilrs_event_system};
use rumble::{play_gilrs_rumble, RunningRumbleEffects}; use rumble::{play_gilrs_rumble, RunningRumbleEffects};
/// Plugin that provides gamepad handling to an [`App`].
#[derive(Default)] #[derive(Default)]
pub struct GilrsPlugin; pub struct GilrsPlugin;