From 20fd162bb6fe934d66a40f2011fa7cf39f6ef214 Mon Sep 17 00:00:00 2001
From: Giovanni La Mura <giovanni.lamura@inaf.it>
Date: Mon, 5 Feb 2024 15:21:51 +0100
Subject: [PATCH] Add cocumentation to ScattererConfiguration comparison
operator
---
src/include/Configuration.h | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/src/include/Configuration.h b/src/include/Configuration.h
index 208a69ba..37338bdf 100644
--- a/src/include/Configuration.h
+++ b/src/include/Configuration.h
@@ -306,7 +306,7 @@ public:
* for dimensions).
* \param dc_matrix: Matrix of reference dielectric constants.
* \param has_external: `bool` Flag to set whether to add an external spherical layer.
- * \param exdc: `double` EXDC
+ * \param exdc: `double` External medium dielectric constant.
* \param wp: `double` wp
* \param xip: `double` xip
*/
@@ -396,6 +396,12 @@ public:
void write_formatted(std::string file_name);
/*! \brief Test whether two instances of ScattererConfiguration are equal.
+ *
+ * ScattererConfiguration objects can be obtained in a variety of manner. They can
+ * be constructed manually, through the class constructor, they can be read from
+ * formatted configuration files, or they can be loaded from binary files. The `==`
+ * operator tests for the equivalence of two configuration instances, returning `true`
+ * if they are equivalnet, `false` otherwise.
*
* \param other: `ScattererConfiguration &` Reference to the instance to be compared with.
* \return result: `bool` True, if the two instances are equal, false otherwise.
--
GitLab