[doc] mpiExample (base layer)

topology-tool-kit · Sep 17, 2024 · 8ac7cff · 8ac7cff
1 parent 1ab86b2
commit 8ac7cff
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 1 deletion.
diff --git a/core/base/arrayPreconditioning/ArrayPreconditioning.h b/core/base/arrayPreconditioning/ArrayPreconditioning.h
@@ -9,7 +9,10 @@
 /// In distributed, using GlobalOrder set to True, this module will compute a
 /// global order, otherwise each process will locally compute its order.
 ///
-
+/// \b Online \b examples:\n
+/// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
 #pragma once
 
 // ttk common includes

diff --git a/core/base/integralLines/IntegralLines.h b/core/base/integralLines/IntegralLines.h
@@ -12,6 +12,11 @@
 /// lines along the edges of the input triangulation.
 ///
 /// \sa ttkIntegralLines.cpp %for a usage example.
+///
+/// \b Online \b examples:\n
+/// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
 
 #pragma once
 

diff --git a/core/base/scalarFieldCriticalPoints/ScalarFieldCriticalPoints.h b/core/base/scalarFieldCriticalPoints/ScalarFieldCriticalPoints.h
@@ -38,6 +38,9 @@
 /// href="https://topology-tool-kit.github.io/examples/interactionSites/">
 /// Interaction sites</a> \n
 /// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
+/// - <a
 /// href="https://topology-tool-kit.github.io/examples/uncertainStartingVortex/">
 /// Uncertain Starting Vortex example</a> \n
 

diff --git a/core/base/scalarFieldSmoother/ScalarFieldSmoother.h b/core/base/scalarFieldSmoother/ScalarFieldSmoother.h
@@ -42,6 +42,9 @@
 /// href="https://topology-tool-kit.github.io/examples/morseSmaleSegmentation_at/">Morse-Smale
 /// segmentation example</a> \n
 /// - <a
+/// href="https://topology-tool-kit.github.io/examples/mpiExample/">
+/// MPI example</a> \n
+/// - <a
 /// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
 /// Diagram Principal Geodesic Analysis example</a> \n
 /// - <a