Update some doc strings

Author: w1th0utnam3

splashsurf/src/reconstruct.rs

@@ -424,13 +424,13 @@ pub(crate) fn reconstruct_subcommand(
     result
 }
 
-/// Struct to hold the result of the reconstruction pipeline
+/// Struct returned as output of the [`reconstruction_pipeline`] function
 pub struct ReconstructionResult<I: Index, R: Real> {
-    /// Holds the reconstructed triangle mesh with optional data (if `generate_quads` was not enabled)
+    /// Holds the reconstructed triangle mesh (if [`generate_quads`](ReconstructionPostprocessingParameters::generate_quads) was not enabled)
     pub tri_mesh: Option<MeshWithData<R, TriMesh3d<R>>>,
-    /// Holds the reconstructed quad mesh with optional data (only if `generate_quads` was enabled)
+    /// Holds the reconstructed mixed triangle/quad mesh (only if [`generate_quads`](ReconstructionPostprocessingParameters::generate_quads) was enabled)
     pub tri_quad_mesh: Option<MeshWithData<R, MixedTriQuadMesh3d<R>>>,
-    /// Holds the surface reconstruction with no post-processing applied if `output_raw_mesh` was enabled
+    /// Holds the initial [`SurfaceReconstruction`] with no post-processing applied (only if [`output_raw_mesh`](ReconstructionPostprocessingParameters::output_raw_mesh) was enabled)
     pub raw_reconstruction: Option<SurfaceReconstruction<I, R>>,
 }
 
@@ -445,27 +445,27 @@ pub struct ReconstructionPostprocessingParameters {
     pub check_mesh_orientation: bool,
     /// Enable additional debug output for the check-mesh operations (has no effect if no other check-mesh option is enabled)
     pub check_mesh_debug: bool,
-    /// Enable MC specific mesh decimation/simplification which removes bad quality triangles typically generated by MC by snapping (enabled by default if smoothing is enabled)
+    /// Enable MC specific mesh decimation/simplification to remove bad quality triangles typically generated by MC by snapping (enabled by default if smoothing is enabled)
     pub mesh_cleanup: bool,
     /// If MC mesh cleanup is enabled, vertex snapping can be limited to this distance relative to the MC edge length (should be in the interval `[0.0,0.5]`)
     pub mesh_cleanup_snap_dist: Option<f64>,
     /// Enable decimation of some typical bad marching cubes triangle configurations (resulting in "barnacles" after Laplacian smoothing)
     pub decimate_barnacles: bool,
     /// Enable preserving vertices without connectivity during decimation instead of filtering them out (faster and helps with debugging)
     pub keep_vertices: bool,
-    /// Enable computing surface normals at the mesh vertices and write them to the output object
+    /// Enable computing per-vertex surface normals
     pub compute_normals: bool,
     /// Enable computing the normals using SPH interpolation instead of using the area weighted triangle normals
     pub sph_normals: bool,
-    /// Number of smoothing iterations to apply to normals if normal interpolation is enabled
+    /// Number of Laplacian smoothing iterations to apply to normals if normal interpolation is enabled
     pub normals_smoothing_iters: Option<usize>,
-    /// Interpolate point attributes with the given name from the input attributes to the reconstructed surface
+    /// Interpolate point attributes with the given names from the input attributes to the reconstructed surface
     pub interpolate_attributes: Vec<String>,
-    /// Number of smoothing iterations to run on the reconstructed mesh
+    /// Number of Laplacian smoothing iterations to apply t the reconstructed mesh
     pub mesh_smoothing_iters: Option<usize>,
     /// Enable feature weights for mesh smoothing if mesh smoothing enabled. Preserves isolated particles even under strong smoothing.
     pub mesh_smoothing_weights: bool,
-    /// Override a manual normalization value from weighted number of neighbors to mesh smoothing weights
+    /// Override the normalization value from weighted number of neighbors to mesh smoothing weights
     pub mesh_smoothing_weights_normalization: f64,
     /// Enable conversion of triangles to quads if they meet quality criteria
     pub generate_quads: bool,
@@ -475,12 +475,11 @@ pub struct ReconstructionPostprocessingParameters {
     pub quad_max_normal_angle: f64,
     /// Maximum allowed vertex interior angle (in degrees) inside a quad to merge two triangles to a quad
     pub quad_max_interior_angle: f64,
-    /// Enable writing the smoothing weights as a vertex attribute to the output mesh file
+    /// Enable storing the smoothing weights as a vertex attribute to the output mesh
     pub output_mesh_smoothing_weights: bool,
-    /// Enable writing raw normals without smoothing to the output mesh if normal smoothing is enabled
+    /// Enable storing the raw normals without smoothing to the output mesh if normal smoothing is enabled
     pub output_raw_normals: bool,
-    // For reconstruction_pipeline_from_args/path: Enable writing the raw reconstructed mesh before applying any post-processing steps (like smoothing or decimation)
-    /// When true, also return the SurfaceReconstruction object with no post-processing applied
+    /// Enable additionally returning the initial [`SurfaceReconstruction`] before any post-processing was applied
     pub output_raw_mesh: bool,
     /// Bounding-box for the surface mesh, triangles completely outside are removed
     pub mesh_aabb: Option<Aabb3d<f64>>,