bevy/crates
Federico Rinaldi 615d43b998 Improve bevy_ecs and bevy_app API docs where referenced by the new Bevy Book (#2365)
## Objective

The upcoming Bevy Book makes many references to the API documentation of bevy.

Most references belong to the first two chapters of the Bevy Book:

- bevyengine/bevy-website#176
- bevyengine/bevy-website#182

This PR attempts to improve the documentation of `bevy_ecs` and `bevy_app` in order to help readers of the Book who want to delve deeper into technical details.

## Solution

- Add crate and level module documentation
- Document the most important items (basically those included in the preludes), with the following style, where applicable:
    - **Summary.** Short description of the item.
    - **Second paragraph.** Detailed description of the item, without going too much in the implementation.
    - **Code example(s).**
    - **Safety or panic notes.**

## Collaboration

Any kind of collaboration is welcome, especially corrections, wording, new ideas and guidelines on where the focus should be put in.

---

### Related issues

- Fixes #2246
2021-09-17 18:00:29 +00:00
..
bevy_app Improve bevy_ecs and bevy_app API docs where referenced by the new Bevy Book (#2365) 2021-09-17 18:00:29 +00:00
bevy_asset Doc warnings (#2577) 2021-09-14 22:46:18 +00:00
bevy_audio Not me ... us (#2654) 2021-08-15 20:08:52 +00:00
bevy_core Nightly clippy fixes (#2702) 2021-09-09 16:41:21 +00:00
bevy_derive Not me ... us (#2654) 2021-08-15 20:08:52 +00:00
bevy_diagnostic add get_history function to Diagnostic (#2772) 2021-09-06 19:16:08 +00:00
bevy_dylib Not me ... us (#2654) 2021-08-15 20:08:52 +00:00
bevy_dynamic_plugin Not me ... us (#2654) 2021-08-15 20:08:52 +00:00
bevy_ecs Improve bevy_ecs and bevy_app API docs where referenced by the new Bevy Book (#2365) 2021-09-17 18:00:29 +00:00
bevy_gilrs Not me ... us (#2654) 2021-08-15 20:08:52 +00:00
bevy_gltf Not me ... us (#2654) 2021-08-15 20:08:52 +00:00
bevy_input Add convenience methods for checking a set of inputs (#2760) 2021-09-01 21:21:41 +00:00
bevy_internal Add trace_tracy feature for Tracy profiling (#2832) 2021-09-16 23:39:22 +00:00
bevy_log Add trace_tracy feature for Tracy profiling (#2832) 2021-09-16 23:39:22 +00:00
bevy_macro_utils Not me ... us (#2654) 2021-08-15 20:08:52 +00:00
bevy_math Update glam requirement from 0.17.3 to 0.18.0 (#2748) 2021-09-06 18:49:40 +00:00
bevy_pbr Doc warnings (#2577) 2021-09-14 22:46:18 +00:00
bevy_reflect Nightly clippy fixes (#2702) 2021-09-09 16:41:21 +00:00
bevy_render Derive thiserror::Error for HexColorError (#2740) 2021-08-30 21:56:13 +00:00
bevy_scene System Param Lifetime Split (#2605) 2021-08-15 20:51:53 +00:00
bevy_sprite Document collide args (#2721) 2021-08-24 18:07:51 +00:00
bevy_tasks Not me ... us (#2654) 2021-08-15 20:08:52 +00:00
bevy_text Replace .insert_resource(T::default()) calls with init_resource::<T>() (#2807) 2021-09-13 14:02:28 +00:00
bevy_transform Add builder methods to Transform (#2778) 2021-09-09 00:46:39 +00:00
bevy_ui unused deps? (#2809) 2021-09-16 09:37:12 +00:00
bevy_utils derive Debug, Clone for FixedState (StableAHash) (#2694) 2021-08-24 01:31:39 +00:00
bevy_wgpu Nightly clippy fixes (#2702) 2021-09-09 16:41:21 +00:00
bevy_window unused deps? (#2809) 2021-09-16 09:37:12 +00:00
bevy_winit Fix scale_factor_override in the winit backend (#2784) 2021-09-10 18:46:16 +00:00