diff --git a/src/geometry.rs b/src/geometry.rs index fcd7ce2..62e77bf 100644 --- a/src/geometry.rs +++ b/src/geometry.rs @@ -91,14 +91,14 @@ impl GeometryBuilder { self } - /// Returns a [`Path`] using the data contained in the geometry + /// Returns a [`Shape`] using the data contained in the geometry /// builder. #[must_use] pub fn build(self) -> Shape { Shape(self.0.build()) } - /// Returns a [`Path`] component with only one geometry. + /// Returns a [`Shape`] component with only one geometry. /// /// # Example /// diff --git a/src/path.rs b/src/path.rs index f801bd7..d928d75 100644 --- a/src/path.rs +++ b/src/path.rs @@ -112,7 +112,7 @@ impl PathBuilder { Self(Builder::new().with_svg()) } - /// Returns a finalized [`Path`]. + /// Returns a finalized [`Shape`]. #[must_use] pub fn build(self) -> Shape { Shape(self.0.build()) diff --git a/src/plugin.rs b/src/plugin.rs index c239753..3975342 100644 --- a/src/plugin.rs +++ b/src/plugin.rs @@ -2,14 +2,6 @@ //! //! The [`ShapePlugin`] provides the creation of shapes with minimal //! boilerplate. -//! -//! ## How it works -//! The user spawns a [`ShapeBundle`](crate::entity::ShapeBundle) from a -//! system in the `UPDATE` stage. -//! -//! Then, in [`Stage::Shape`] stage, there is a system -//! that creates a mesh for each entity that has been spawned as a -//! `ShapeBundle`. use bevy::{ color::palettes, @@ -60,7 +52,8 @@ impl Plugin for ShapePlugin { #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, SystemSet)] pub struct BuildShapes; -/// Queries all the [`ShapeBundle`]s to mesh them when they are added +/// Queries all the [`Shape`]s and their related components +/// to mesh them when they are added /// or re-mesh them when they are changed. #[allow(clippy::type_complexity)] fn mesh_shapes_system(