From 6b47590cf017d9dde860bc64e585f298e0e21265 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Wed, 23 Oct 2024 19:56:15 +0200 Subject: [PATCH] Update doc comments --- crates/fj-core/src/geometry/geometry.rs | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/crates/fj-core/src/geometry/geometry.rs b/crates/fj-core/src/geometry/geometry.rs index 4c07e5fa9..cd08813fc 100644 --- a/crates/fj-core/src/geometry/geometry.rs +++ b/crates/fj-core/src/geometry/geometry.rs @@ -267,17 +267,11 @@ pub struct LocalCurveGeom { pub path: Path<2>, } -/// # The geometric definition of a curve +/// # A generator for curve geometry /// /// Curves are represented by polylines, their uniform intermediate /// representation. However, this representation can be 2D (local to a surface) /// or 3D. This enum distinguishes between the two cases. -/// -/// ## Implementation Note -/// -/// The name, `CurveGeom2`, is a placeholder. As of this writing, there is an -/// ongoing transition to a new geometry system, and the name `CurveGeom` is -/// still taken by an old-style type. pub enum CurveGenerator { /// # The curve is defined locally on a surface Surface { @@ -295,7 +289,7 @@ pub enum CurveGenerator { }, } -/// # The geometric definition of a surface +/// # A generator for surface geometry /// /// Surface are represented by triangle meshes, their uniform intermediate /// representation.