Update documentation

Author: w1th0utnam3

splashsurf_lib/Cargo.toml

@@ -17,9 +17,15 @@ repository.workspace = true
 # RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps --open
 # Build with all features to properly document everything
 all-features = true
-# Build only for a single target as this crate does not have any platform specific behavior
-default-target = "x86_64-unknown-linux-gnu"
-targets = []
+targets = [
+  "x86_64-unknown-linux-gnu",
+  "i686-unknown-linux-gnu",
+  "aarch64-unknown-linux-gnu",
+  "aarch64-apple-darwin",
+  "x86_64-apple-darwin",
+  "x86_64-pc-windows-msvc",
+  "i686-pc-windows-msvc"
+]
 
 # Ignore the tests (especially the test mesh files) for publishing
 exclude = ["tests/*", "benches/*"]

splashsurf_lib/src/kernel.rs

@@ -1,4 +1,10 @@
 //! SPH kernel function implementations
+//!
+//! Currently, the following SIMD implementations are provided:
+//!  - `CubicSplineKernelAvxF32`: Only available on `x86` and `x86_64` targets, requires AVX2 and FMA support
+//!  - `CubicSplineKernelNeonF32`: Only available on `aarch64` targets, requires NEON support
+//!
+//! Note that documentation of the SIMD kernels is only available on the respective target architectures.
 
 use crate::{Real, RealConvert};
 use nalgebra::Vector3;
@@ -173,7 +179,7 @@ fn test_cubic_kernel_r_integral() {
     }
 }
 
-/// Vectorized implementation of the cubic spline kernel using NEON instructions. Only available on aarch64 targets.
+/// Vectorized implementation of the cubic spline kernel using NEON instructions. Only available on `aarch64` targets.
 #[cfg(target_arch = "aarch64")]
 pub struct CubicSplineKernelNeonF32 {
     compact_support_inv: f32,
@@ -305,7 +311,7 @@ fn test_cubic_spline_kernel_neon() {
     }
 }
 
-/// Vectorized implementation of the cubic spline kernel using AVX2 and FMA instructions. Only available on x86 and x86_64 targets.
+/// Vectorized implementation of the cubic spline kernel using AVX2 and FMA instructions. Only available on `x86` and `x86_64` targets.
 #[cfg(any(target_arch = "x86_64", target_arch = "x86"))]
 pub struct CubicSplineKernelAvxF32 {
     compact_support_inv: f32,