Add docs to ah::ObjectLabel

sxs-collaboration · Dec 19, 2022 · 85577b8 · 85577b8
1 parent e44a3ce
commit 85577b8
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/ApparentHorizons/ObjectLabel.hpp b/src/ApparentHorizons/ObjectLabel.hpp
@@ -8,7 +8,12 @@
 
 namespace ah {
 /// Labels for the objects in a binary system.
-enum class ObjectLabel { A, B };
+enum class ObjectLabel {
+  /// The object on the right side (along the grid-frame x-axis)
+  A,
+  /// The object on the left side (along the grid-frame x-axis)
+  B
+};
 
 std::string name(const ObjectLabel x);