Update docs

Author: w1th0utnam3

splashsurf_lib/src/density_map.rs

@@ -13,7 +13,7 @@
 //! "flat point indices". These are computed from the background grid point coordinates `(i,j,k)`
 //! analogous to multidimensional array index flattening. That means for a grid with dimensions
 //! `[n_x, n_y, n_z]`, the flat point index is given by the expression `i*n_x + j*n_y + k*n_z`.
-//! For these point index operations, the [`UniformGrid`](crate::UniformGrid) is used.
+//! For these point index operations, the [`UniformGrid`] is used.
 //!
 //! Note that all density mapping functions always use the global background grid for flat point
 //! indices, even if the density map is only generated for a smaller subdomain.

splashsurf_lib/src/lib.rs

@@ -9,7 +9,7 @@
 //! The following features are all non-default features to reduce the amount of additional dependencies.
 //!
 //! - **`vtk_extras`**: Enables helper functions and trait implementations to export meshes using [`vtkio`](https://github.com/elrnv/vtkio).
-//!  In particular it adds `From` impls for the [mesh](crate::mesh) types used by this crate to convert them to
+//!  In particular it adds `From` impls for the [mesh] types used by this crate to convert them to
 //!  [`vtkio::model::UnstructuredGridPiece`](https://docs.rs/vtkio/0.6.*/vtkio/model/struct.UnstructuredGridPiece.html) and [`vtkio::model::DataSet`](https://docs.rs/vtkio/0.6.*/vtkio/model/enum.DataSet.html)
 //!  types. If the feature is enabled, The crate exposes its `vtkio` dependency as `splashsurflib::vtkio`.
 //! - **`io`**: Enables the [`io`] module, containing functions to load and store particle and mesh files

splashsurf_lib/src/marching_cubes.rs

@@ -1,4 +1,4 @@
-//! Triangulation of [`DensityMap`](crate::density_map::DensityMap)s using marching cubes
+//! Triangulation of [`DensityMap`]s using marching cubes
 
 use crate::marching_cubes::narrow_band_extraction::{
     construct_mc_input, construct_mc_input_with_stitching_data,

splashsurf_lib/src/mesh.rs

@@ -1355,15 +1355,15 @@ impl<R: Real> MeshAttribute<R> {
         }
     }
 
-    /// Creates a new named mesh attribute with scalar values implementing the [`Real`](crate::Real) trait
+    /// Creates a new named mesh attribute with scalar values implementing the [`Real`] trait
     pub fn new_real_scalar<S: Into<String>>(name: S, data: impl Into<Vec<R>>) -> Self {
         Self {
             name: name.into(),
             data: AttributeData::ScalarReal(data.into()),
         }
     }
 
-    /// Creates a new named mesh attribute with scalar values implementing the [`Real`](crate::Real) trait
+    /// Creates a new named mesh attribute with scalar values implementing the [`Real`] trait
     pub fn new_real_vector3<S: Into<String>>(name: S, data: impl Into<Vec<Vector3<R>>>) -> Self {
         Self {
             name: name.into(),

splashsurf_lib/src/octree.rs

@@ -397,7 +397,7 @@ impl<I: Index, R: Real> OctreeNode<I, R> {
         &self.aabb
     }
 
-    /// Constructs a [`UniformGrid`](crate::UniformGrid) that represents the domain of this octree node
+    /// Constructs a [`UniformGrid`] that represents the domain of this octree node
     pub fn grid(
         &self,
         min: &Vector3<R>,

splashsurf_lib/src/postprocessing.rs

@@ -82,7 +82,8 @@ pub fn par_laplacian_smoothing_normals_inplace<R: Real>(
 
 /// Mesh simplification designed for marching cubes surfaces meshes inspired by the "Compact Contouring"/"Mesh displacement" approach by Doug Moore and Joe Warren
 ///
-/// See ["Mesh Displacement: An Improved Contouring Method for Trivariate Data"](https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.49.5214&rep=rep1&type=pdf).
+/// See Moore and Warren: ["Mesh Displacement: An Improved Contouring Method for Trivariate Data"](https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.49.5214&rep=rep1&type=pdf) (1991)
+/// or Moore and Warren: "Compact Isocontours from Sampled Data" in "Graphics Gems III" (1992).
 pub fn marching_cubes_cleanup<I: Index, R: Real>(
     mesh: &mut TriMesh3d<R>,
     grid: &UniformCartesianCubeGrid3d<I, R>,