Remove Read, add docs for all pub types

Author: UberLambda

crates/bevy_pbr/src/wireframe.rs

@@ -67,7 +67,7 @@ fn extract_wireframe_config(mut commands: Commands, wireframe_config: Res<Wirefr
     }
 }
 
-fn extract_wireframes(mut commands: Commands, query: Query<(Entity, Read<Wireframe>)>) {
+fn extract_wireframes(mut commands: Commands, query: Query<(Entity, &Wireframe)>) {
     for (entity, wireframe) in query.iter() {
         commands.get_or_spawn(entity).insert(wireframe.clone());
     }
@@ -113,6 +113,8 @@ fn prepare_wireframes(
         .write_buffer(&render_device, &render_queue);
 }
 
+/// Internal [`WireframePlugin`] resource.  
+/// [`GlobalWireframeBindGroup`] stores the [`BindGroup`] of wireframe data that is used on the GPU side.
 pub struct GlobalWireframeBindGroup {
     pub bind_group: BindGroup,
 }
@@ -173,15 +175,21 @@ impl Default for WireframeConfig {
     }
 }
 
+/// Internal [`WireframePlugin`] component.  
+/// [`WireframeUniformOffset`] holds the offset of a [`WireframeUniform`] in the [`GlobalWireframeMeta::uniforms`].
 #[derive(Component, Copy, Clone, Debug, Default)]
 #[repr(transparent)]
-pub struct WireframeUniformOffset(u32);
+pub struct WireframeUniformOffset(pub u32);
 
+/// Internal [`WireframePlugin`] state.  
+/// [`WireframeUniform`] is the GPU representation of a [`Wireframe`].
 #[derive(Debug, AsStd140)]
 pub struct WireframeUniform {
     pub color: Vec4,
 }
 
+/// Internal [`WireframePlugin`] resource.  
+/// This is the GPU representation of a [`Wireframe`].
 #[derive(Component)]
 pub struct GlobalWireframeMeta {
     pub uniforms: DynamicUniformVec<WireframeUniform>,
@@ -216,6 +224,8 @@ impl FromWorld for GlobalWireframeMeta {
     }
 }
 
+/// Internal [`WireframePlugin`] resource.  
+/// [`WireframePipeline`] is the specialized rendering pipeline for wireframes.
 pub struct WireframePipeline {
     mesh_pipeline: MeshPipeline,
     wireframe_bind_group_layout: BindGroupLayout,
@@ -303,6 +313,8 @@ fn queue_wireframes(
     }
 }
 
+/// Internal [`WireframePlugin`] render command.  
+/// [`SetWireframeBindGroup`]`<bindgroup index>` binds the [`GlobalWireframeBindGroup`] there.
 pub struct SetWireframeBindGroup<const I: usize>;
 impl<const I: usize> EntityRenderCommand for SetWireframeBindGroup<I> {
     type Param = (