From ccc5db22ac011df1dc75bd17393c7c697b9db2be Mon Sep 17 00:00:00 2001
From: Mikhail Svechnikov <svechnikovmv@gmail.com>
Date: Tue, 16 Jan 2024 20:12:39 +0100
Subject: [PATCH] comment MesoOptions

---
 Base/Types/SimOptions.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Base/Types/SimOptions.h b/Base/Types/SimOptions.h
index 5172be281f7..46af5f84851 100644
--- a/Base/Types/SimOptions.h
+++ b/Base/Types/SimOptions.h
@@ -29,8 +29,9 @@ struct ThreadInfo {
 //! Options to compute mesocrystal formfactors.
 
 struct MesoOptions {
-    bool use_reciprocal_sum{true}; // TODO: change to 'false' in framework of issue #510
-    double radius_factor{2.1};
+    // TODO: change to 'false' in framework of issue #510
+    bool use_reciprocal_sum{true}; //!< If true, use approximative but faster algorithm
+    double radius_factor{2.1};     //!< Cutoff for fast (reciprocal-sum) algorithm
 };
 
 #endif // BORNAGAIN_BASE_TYPES_SIMOPTIONS_H
-- 
GitLab