rei-mirrors
/
Fornjot
mirror of https://github.com/hannobraun/Fornjot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update doc comments

This commit is contained in:
Hanno Braun 2022-06-28 17:53:51 +02:00
parent f4f9ce2d89
commit 62de46b5e2
4 changed files with 0 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/fj-kernel/src/objects/cycle.rs
View File

@ -11,11 +11,6 @@ use super::{Edge, Surface};
/// edge. The end of the last edge must connect to the beginning of the first /// edge. The end of the last edge must connect to the beginning of the first
/// one. /// one.
/// ///
/// # Equality
///
/// Please refer to [`crate::kernel::topology`] for documentation on the
/// equality of topological objects.
///
/// # Validation /// # Validation
/// ///
/// A cycle that is part of a [`Shape`] must be structurally sound. That means /// A cycle that is part of a [`Shape`] must be structurally sound. That means

5
crates/fj-kernel/src/objects/edge.rs
View File

@ -11,11 +11,6 @@ use super::{Curve, Vertex};
/// An edge of a shape /// An edge of a shape
/// ///
/// # Equality
///
/// Please refer to [`crate::kernel::topology`] for documentation on the
/// equality of topological objects.
///
/// # Validation /// # Validation
/// ///
/// An edge that is part of a [`Shape`] must be structurally sound. That means /// An edge that is part of a [`Shape`] must be structurally sound. That means

5
crates/fj-kernel/src/objects/vertex.rs
View File

@ -13,11 +13,6 @@ use crate::{builder::VertexBuilder, shape::Shape};
/// Points, on the other hand, might be used to approximate a shape for various /// Points, on the other hand, might be used to approximate a shape for various
/// purposes, without presenting any deeper truth about the shape's structure. /// purposes, without presenting any deeper truth about the shape's structure.
/// ///
/// # Equality
///
/// Please refer to [`crate::kernel::topology`] for documentation on the
/// equality of topological objects.
///
/// # Validation /// # Validation
/// ///
/// Vertices must be unique within a shape, meaning an identical vertex must not /// Vertices must be unique within a shape, meaning an identical vertex must not

7
crates/fj-kernel/src/shape/local.rs
View File

@ -5,13 +5,6 @@ use super::Object;
/// This type is used by topological objects to reference other objects, while /// This type is used by topological objects to reference other objects, while
/// also keeping track of a local representation of that object, which is often /// also keeping track of a local representation of that object, which is often
/// more appropriate for various tasks. /// more appropriate for various tasks.
///
/// # Equality
///
/// Since `LocalForm` is used by topological objects, its equality is defined in
/// terms that are useful to those objects. Two instances of `LocalForm` are
/// equal, if both the local and the canonical forms are equal. The equality of
/// the handle that refers to the canonical form is disregarded.
#[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)] #[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub struct LocalForm<Local, Canonical: Object> { pub struct LocalForm<Local, Canonical: Object> {
local: Local, local: Local,