bevy/crates/bevy_input/src
SpecificProtagonist d92fc1e456
Move required components doc to type doc (#16575)
# Objective

Make documentation of a component's required components more visible by
moving it to the type's docs

## Solution

Change `#[require]` from a derive macro helper to an attribute macro.

Disadvantages:
- this silences any unused code warnings on the component, as it is used
by the macro!
- need to import `require` if not using the ecs prelude (I have not
included this in the migration guilde as Rust tooling already suggests
the fix)

---

## Showcase
![Documentation of
Camera](https://github.com/user-attachments/assets/3329511b-747a-4c8d-a43e-57f7c9c71a3c)

---------

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: JMS55 <47158642+JMS55@users.noreply.github.com>
2024-12-03 19:45:20 +00:00
..
axis.rs Gamepad improvements (#16222) 2024-11-04 17:05:24 +00:00
button_input.rs Revert most of #16222 and add gamepad accessors (#16425) 2024-11-19 00:00:16 +00:00
common_conditions.rs Add core and alloc over std Lints (#15281) 2024-09-27 00:59:59 +00:00
gamepad.rs Move required components doc to type doc (#16575) 2024-12-03 19:45:20 +00:00
gestures.rs bevy_input: allow use without bevy_reflect (#14167) 2024-07-08 01:09:07 +00:00
keyboard.rs Use en-us locale for typos (#16037) 2024-10-20 18:55:17 +00:00
lib.rs Use Name component for gamepad (#16233) 2024-11-05 00:30:48 +00:00
mouse.rs Add core and alloc over std Lints (#15281) 2024-09-27 00:59:59 +00:00
touch.rs Simpler lint fixes: makes ci lints work but disables a lint for now (#15376) 2024-09-24 11:42:59 +00:00