#4748 - Since this is the first record of the C++20 spaceship operato…

…r<=>, add comments
NREL · May 10, 2023 · 4ad25dd · 4ad25dd
1 parent e1f60d9
commit 4ad25dd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/utilities/bcl/BCLFileReference.hpp b/src/utilities/bcl/BCLFileReference.hpp
@@ -124,6 +124,9 @@ class UTILITIES_API BCLFileReference
   //@}
 
  protected:
+  // Declaring the equality operator and the spaceship operator (three-way comparison operator) will end up defining all comparison operators
+  // We really need only the operator< for sorting a STL container of BCLFileReference, but might as well be consistent
+  // Comparison is done on m_path. Sorting is useful for BCLXML to avoid reordering of files (see #4748)
   friend bool operator==(const BCLFileReference& lhs, const BCLFileReference& rhs);
   friend std::strong_ordering operator<=>(const BCLFileReference& lhs, const BCLFileReference& rhs);