Add doc comments

geieredgar · Mar 2, 2023 · a05160b · a05160b
1 parent e8440db
commit a05160b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/crates/bevy_pbr/src/prepass/mod.rs b/crates/bevy_pbr/src/prepass/mod.rs
@@ -59,6 +59,9 @@ pub const PREPASS_BINDINGS_SHADER_HANDLE: HandleUntyped =
 pub const PREPASS_UTILS_SHADER_HANDLE: HandleUntyped =
     HandleUntyped::weak_from_u64(Shader::TYPE_UUID, 4603948296044544);
 
+/// Sets up everything required to use the prepass pipeline.
+///
+/// This does not add the actual prepasses, see [`PrepassPipeline`] for that.
 pub struct PrepassPipelinePlugin<M: Material>(PhantomData<M>);
 
 impl<M: Material> Default for PrepassPipelinePlugin<M> {
@@ -105,6 +108,9 @@ where
     }
 }
 
+/// Sets up the prepasses for a [`Material`].
+///
+/// This depends on the [`PrepassPipelinePlugin`].
 pub struct PrepassPlugin<M: Material>(PhantomData<M>);
 
 impl<M: Material> Default for PrepassPlugin<M> {