Update doc comments

This commit is contained in:
Hanno Braun 2023-02-22 13:43:29 +01:00
parent 6c717920d0
commit 2e8320699b

View File

@ -78,7 +78,7 @@ pub struct HalfEdgeApprox {
/// The point that approximates the first vertex of the edge /// The point that approximates the first vertex of the edge
pub first: ApproxPoint<2>, pub first: ApproxPoint<2>,
/// The approximation of the edge's curve /// The approximation of the edge
pub points: Vec<ApproxPoint<2>>, pub points: Vec<ApproxPoint<2>>,
} }
@ -182,7 +182,7 @@ impl EdgeCache {
Self::default() Self::default()
} }
/// Insert the approximation of a [`GlobalCurve`] /// Insert the approximation of a [`GlobalEdge`]
pub fn insert( pub fn insert(
&mut self, &mut self,
handle: Handle<GlobalEdge>, handle: Handle<GlobalEdge>,
@ -193,7 +193,7 @@ impl EdgeCache {
approx approx
} }
/// Access the approximation for the given [`GlobalCurve`], if available /// Access the approximation for the given [`GlobalEdge`], if available
pub fn get( pub fn get(
&self, &self,
handle: Handle<GlobalEdge>, handle: Handle<GlobalEdge>,
@ -212,10 +212,10 @@ impl EdgeCache {
} }
} }
/// An approximation of a [`GlobalCurve`] /// An approximation of a [`GlobalEdge`]
#[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)] #[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub struct GlobalEdgeApprox { pub struct GlobalEdgeApprox {
/// The points that approximate the curve /// The points that approximate the edge
pub points: Vec<ApproxPoint<1>>, pub points: Vec<ApproxPoint<1>>,
} }