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

Update crate-level doc comments

This commit is contained in:
Hanno Braun 2023-05-23 09:27:11 +02:00
parent 35c23589f2
commit 340226edd5
5 changed files with 24 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
crates/fj-export/src/lib.rs
View File

@ -1,14 +1,10 @@
//! # Fornjot Exporter //! # Fornjot Exporter
//! //!
//! This library is part of the [Fornjot] ecosystem. Fornjot is an open-source, //! [Fornjot] is an early-stage b-rep CAD kernel written in Rust. The kernel is
//! code-first CAD application; and collection of libraries that make up the CAD //! split into multiple libraries that can be used semi-independently, and this
//! application, but can be used independently. //! is one of those.
//! //!
//! This library is an internal component of Fornjot. It is not relevant to end //! This library exports Fornjot models to external file formats.
//! users that just want to create CAD models.
//!
//! The purpose of this library is to export Fornjot models to external file
//! formats.
//! //!
//! [Fornjot]: https://www.fornjot.app/ //! [Fornjot]: https://www.fornjot.app/

13
crates/fj-interop/src/lib.rs
View File

@ -1,14 +1,11 @@
//! # Fornjot Interop Types //! # Fornjot Interop Types
//! //!
//! This library is part of the [Fornjot] ecosystem. Fornjot is an open-source, //! [Fornjot] is an early-stage b-rep CAD kernel written in Rust. The kernel is
//! code-first CAD application; and collection of libraries that make up the CAD //! split into multiple libraries that can be used semi-independently, and this
//! application, but can be used independently. //! is one of those.
//! //!
//! This library is an internal component of Fornjot. It is not relevant to end //! This library defines types that allow other components of Fornjot to
//! users that just want to create CAD models. //! interoperate, without having to depend on each other.
//!
//! The purpose of this library is to define types that allow other components
//! of the Fornjot ecosystem to interoperate, without depending on each other.
//! //!
//! [Fornjot]: https://www.fornjot.app/ //! [Fornjot]: https://www.fornjot.app/

14
crates/fj-kernel/src/lib.rs
View File

@ -1,15 +1,11 @@
//! # Fornjot CAD Kernel //! # Fornjot CAD Kernel
//! //!
//! This library is part of the [Fornjot] ecosystem. Fornjot is an open-source, //! [Fornjot] is an early-stage b-rep CAD kernel written in Rust. The kernel is
//! code-first CAD application; and collection of libraries that make up the CAD //! split into multiple libraries that can be used semi-independently, and this
//! application, but can be used independently. //! is one of those.
//! //!
//! This library is an internal component of Fornjot. It is not relevant to end //! This library defines geometric and topological primitives, and the
//! users that just want to create CAD models. //! algorithms that operate on them.
//!
//! The CAD kernel is the core of Fornjot: the geometry, the topology, and the
//! algorithms that handle them. It is separate from the CAD application, and
//! could be used in other applications.
//! //!
//! //!
//! ## Design Principle //! ## Design Principle

14
crates/fj-math/src/lib.rs
View File

@ -1,16 +1,14 @@
//! # Fornjot Math Library //! # Fornjot Math Library
//! //!
//! This library is part of the [Fornjot] ecosystem. Fornjot is an open-source, //! [Fornjot] is an early-stage b-rep CAD kernel written in Rust. The kernel is
//! code-first CAD application; and collection of libraries that make up the CAD //! split into multiple libraries that can be used semi-independently, and this
//! application, but can be used independently. //! is one of those.
//! //!
//! This library is an internal component of Fornjot. It is not relevant to end //! This library provides basic math types for Fornjot. It is built on
//! users that just want to create CAD models. //! [nalgebra] and [Parry], but provides an interface that is specifically
//!
//! This crates provides basic math types for the Fornjot ecosystem. It is built
//! on [nalgebra] and [Parry], but provides an interface that is specifically
//! tailored to the needs of Fornjot. //! tailored to the needs of Fornjot.
//! //!
//!
//! ## Failing [`From`]/[`Into`] implementations //! ## Failing [`From`]/[`Into`] implementations
//! //!
//! Please note that any [`From`]/[`Into`] implementation that convert floating //! Please note that any [`From`]/[`Into`] implementation that convert floating

12
crates/fj-viewer/src/lib.rs
View File

@ -1,14 +1,10 @@
//! # Fornjot Model Viewer //! # Fornjot Model Viewer
//! //!
//! This library is part of the [Fornjot] ecosystem. Fornjot is an open-source, //! [Fornjot] is an early-stage b-rep CAD kernel written in Rust. The kernel is
//! code-first CAD application; and collection of libraries that make up the CAD //! split into multiple libraries that can be used semi-independently, and this
//! application, but can be used independently. //! is one of those.
//! //!
//! This library is an internal component of Fornjot. It is not relevant to end //! This library provides a viewer for Fornjot models.
//! users that just want to create CAD models.
//!
//! This library provides a model viewer which allows basic navigation and
//! rendering of generated models.
//! //!
//! [Fornjot]: https://www.fornjot.app/ //! [Fornjot]: https://www.fornjot.app/