Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs to ah::ObjectLabel #4534

Merged
merged 1 commit into from
Jan 12, 2023
Merged

Add docs to ah::ObjectLabel #4534

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/ApparentHorizons/ObjectLabel.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down