From 74ed30fa3417c5a1bb5f147d779250e5bbdbd521 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 22 Nov 2023 10:38:16 +0100
Subject: Including code reference inside pipeline modules description.

---
 .../pipeline_modules/scan_path_analyzers.md        | 37 ++++++++++++++++------
 1 file changed, 28 insertions(+), 9 deletions(-)

(limited to 'docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md')

diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md
index f9f757a..c779112 100644
--- a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md
+++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md
@@ -3,38 +3,57 @@ Scan path analyzers
 
 ArGaze provides ready-to-use scan path analysis algorithms.
 
-Here are JSON samples to include a chosen module inside [ArFrame configuration](../configuration_and_execution.md) *scan_path_analyzers* entry.
+The JSON samples have to be included inside [ArFrame configuration](../configuration_and_execution.md) *scan_path_analyzers* entry to select an algorithm.
+
+```json
+"scan_path_analyzers": {
+	JSON sample
+}
+```
+
+Read more about [ScanPathAnalyzer base class in code reference](../../../argaze.md/#argaze.GazeFeatures.ScanPathAnalyzer).
+
+!!! note
+
+	The members indicated as **property** are what returns the analyzer.
 
 ## Basic metrics
 
+::: argaze.GazeAnalysis.Basic.ScanPathAnalyzer
+
+### JSON sample
+
 ```json
 "Basic": {}
 ```
 
-[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.Basic.ScanPathAnalyzer)
-
 ## Explore/Exploit ratio
 
+::: argaze.GazeAnalysis.ExploreExploitRatio.ScanPathAnalyzer
+
+### JSON sample
+
 ```json
 "ExploreExploitRatio": {
 	"short_fixation_duration_threshold": 0
 }
 ```
 
-[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.ExploreExploitRatio.ScanPathAnalyzer)
-
 ## K coefficient
 
+::: argaze.GazeAnalysis.KCoefficient.ScanPathAnalyzer
+
+### JSON sample
+
 ```json
 "KCoefficient": {}
 ```
 
-[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.KCoefficient.ScanPathAnalyzer)
-
 ## Nearest neighbor index
 
+::: argaze.GazeAnalysis.NearestNeighborIndex.ScanPathAnalyzer
+
+### JSON sample
 ```json
 "NearestNeighborIndex": {}
 ```
-
-[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.NearestNeighborIndex.ScanPathAnalyzer)
\ No newline at end of file
-- 
cgit v1.1