Skip to content
Snippets Groups Projects
Commit 20fd162b authored by Giovanni La Mura's avatar Giovanni La Mura
Browse files

Add cocumentation to ScattererConfiguration comparison operator

parent 5227de52
No related branches found
No related tags found
No related merge requests found
...@@ -306,7 +306,7 @@ public: ...@@ -306,7 +306,7 @@ public:
* for dimensions). * for dimensions).
* \param dc_matrix: Matrix of reference dielectric constants. * \param dc_matrix: Matrix of reference dielectric constants.
* \param has_external: `bool` Flag to set whether to add an external spherical layer. * \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 wp: `double` wp
* \param xip: `double` xip * \param xip: `double` xip
*/ */
...@@ -396,6 +396,12 @@ public: ...@@ -396,6 +396,12 @@ public:
void write_formatted(std::string file_name); void write_formatted(std::string file_name);
/*! \brief Test whether two instances of ScattererConfiguration are equal. /*! \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. * \param other: `ScattererConfiguration &` Reference to the instance to be compared with.
* \return result: `bool` True, if the two instances are equal, false otherwise. * \return result: `bool` True, if the two instances are equal, false otherwise.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment