615d43b998
## 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
16 lines
240 B
Rust
16 lines
240 B
Rust
//! Storage layouts for ECS data.
|
|
|
|
mod blob_vec;
|
|
mod sparse_set;
|
|
mod table;
|
|
|
|
pub use blob_vec::*;
|
|
pub use sparse_set::*;
|
|
pub use table::*;
|
|
|
|
#[derive(Default)]
|
|
pub struct Storages {
|
|
pub sparse_sets: SparseSets,
|
|
pub tables: Tables,
|
|
}
|