Skip to content

Commit d4dc115

Browse files
authored
Add more notes about bevy's modules (#771)
1 parent 53c4c45 commit d4dc115

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

src/lib.rs

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
//!
3333
//! If you prefer, you can also consume the individual bevy crates directly.
3434
//! Each module in the root of this crate, except for the prelude, can be found on crates.io
35-
//! with `bevy_` appended to the front, e.g. `app` -> [`bevy_app`](https://docs.rs/bevy_app/0.2.1/bevy_app/).
35+
//! with `bevy_` appended to the front, e.g. `app` -> [`bevy_app`](https://docs.rs/bevy_app/*/bevy_app/).
3636
3737
#![doc(
3838
html_logo_url = "https://bevyengine.org/assets/icon.png",
@@ -51,7 +51,7 @@ pub mod app {
5151
}
5252

5353
pub mod asset {
54-
//! Load and store assets and resources for Apps
54+
//! Load and store assets and resources for Apps.
5555
pub use bevy_asset::*;
5656
}
5757

@@ -76,6 +76,7 @@ pub mod input {
7676
}
7777

7878
pub mod math {
79+
//! Math types (Vec3, Mat4, Quat, etc) and helpers.
7980
pub use bevy_math::*;
8081
}
8182

@@ -85,18 +86,22 @@ pub mod property {
8586
}
8687

8788
pub mod scene {
89+
//! Save/load collections of entities and components to/from file.
8890
pub use bevy_scene::*;
8991
}
9092

9193
pub mod tasks {
94+
//! Pools for async, IO, and compute tasks.
9295
pub use bevy_tasks::*;
9396
}
9497

9598
pub mod transform {
99+
//! Local and global transforms (e.g. translation, scale, rotation).
96100
pub use bevy_transform::*;
97101
}
98102

99103
pub mod type_registry {
104+
//! Registered types and components can be used when loading scenes.
100105
pub use bevy_type_registry::*;
101106
}
102107

@@ -105,6 +110,7 @@ pub mod utils {
105110
}
106111

107112
pub mod window {
113+
//! Configuration, creation, and management of one or more windows.
108114
pub use bevy_window::*;
109115
}
110116

@@ -122,12 +128,14 @@ pub mod gltf {
122128

123129
#[cfg(feature = "bevy_pbr")]
124130
pub mod pbr {
125-
//! Physically based rendering. **Note**: true PBR has not yet been implemented; the name `pbr` is aspirational.
131+
//! Physically based rendering.
132+
//! **Note**: true PBR has not yet been implemented; the name `pbr` is aspirational.
126133
pub use bevy_pbr::*;
127134
}
128135

129136
#[cfg(feature = "bevy_render")]
130137
pub mod render {
138+
//! Cameras, meshes, textures, shaders, and pipelines.
131139
pub use bevy_render::*;
132140
}
133141

@@ -139,11 +147,13 @@ pub mod sprite {
139147

140148
#[cfg(feature = "bevy_text")]
141149
pub mod text {
150+
//! Text drawing, styling, and font assets.
142151
pub use bevy_text::*;
143152
}
144153

145154
#[cfg(feature = "bevy_ui")]
146155
pub mod ui {
156+
//! User interface components and widgets.
147157
pub use bevy_ui::*;
148158
}
149159

@@ -154,6 +164,7 @@ pub mod winit {
154164

155165
#[cfg(feature = "bevy_wgpu")]
156166
pub mod wgpu {
167+
//! A render backend utilizing [wgpu](https://github.com/gfx-rs/wgpu-rs).
157168
pub use bevy_wgpu::*;
158169
}
159170

0 commit comments

Comments
 (0)