rei-mirrors/Fornjot
1
0
Fork 0
mirror of https://github.com/hannobraun/Fornjot synced 2025-10-15 04:18:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update doc comments

Browse Source
This commit is contained in:
Hanno Braun 2024-10-23 19:56:15 +02:00
parent 90a378f32a
commit 6b47590cf0
1 changed files with 2 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/fj-core/src/geometry/geometry.rs
View File

@ -267,17 +267,11 @@ pub struct LocalCurveGeom {
pub path: Path<2>, pub path: Path<2>,
} }
/// # The geometric definition of a curve /// # A generator for curve geometry
/// ///
/// Curves are represented by polylines, their uniform intermediate /// Curves are represented by polylines, their uniform intermediate
/// representation. However, this representation can be 2D (local to a surface) /// representation. However, this representation can be 2D (local to a surface)
/// or 3D. This enum distinguishes between the two cases. /// 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 { pub enum CurveGenerator {
/// # The curve is defined locally on a surface /// # The curve is defined locally on a surface
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 /// Surface are represented by triangle meshes, their uniform intermediate
/// representation. /// representation.