Add docs to ah::ObjectLabel

sxs-collaboration · Dec 21, 2022 · ee37409 · ee37409
1 parent e44a3ce
commit ee37409
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 along the positive x-axis in the grid frame
+  A,
+  /// The object along the negative x-axis in the grid frame
+  B
+};
 
 std::string name(const ObjectLabel x);