bevy/crates/bevy_scene/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
..
bundle.rs Allow World::entity family of functions to take multiple entities and get multiple references back (#15614) 2024-10-07 15:21:40 +00:00
components.rs Move required components doc to type doc (#16575) 2024-12-03 19:45:20 +00:00
dynamic_scene.rs Migrate scenes to required components (#15579) 2024-10-01 22:42:11 +00:00
dynamic_scene_builder.rs bevy_scene: Use FromReflect on extracted resources (#15753) 2024-10-09 02:56:35 +00:00
lib.rs Migrate scenes to required components (#15579) 2024-10-01 22:42:11 +00:00
scene.rs Add scene summary (#15679) 2024-10-06 19:03:56 +00:00
scene_filter.rs Add core and alloc over std Lints (#15281) 2024-09-27 00:59:59 +00:00
scene_loader.rs Remove thiserror from bevy_scene (#15764) 2024-10-09 14:29:10 +00:00
scene_spawner.rs fix: add reflect to SceneInstanceReady and other observers/events (#16018) 2024-10-20 13:51:41 +00:00
serde.rs Fix some duplicate words in docs/comments (#15980) 2024-10-20 01:03:27 +00:00