Documented enumerators of two enum classes.

This is necessary for Doxygen to show them in the right places.
tov · Feb 17, 2020 · 6c01f6d · 6c01f6d
1 parent de61aa8
commit 6c01f6d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/include/ge211_error.hxx b/include/ge211_error.hxx
@@ -152,9 +152,13 @@ namespace detail {
 
 enum class Log_level
 {
+    /// extra debugging information
     debug,
+    /// helpful information
     info,
+    /// non-fatal but concerning conditions
     warn,
+    /// serious errors
     fatal,
 };
 

diff --git a/include/ge211_event.hxx b/include/ge211_event.hxx
@@ -17,7 +17,12 @@ namespace events {
 /// which mouse button was depressed or released.
 enum class Mouse_button
 {
-    left, middle, right,
+    /// the primary mouse button
+    left,
+    /// the tertiary mouse button
+    middle,
+    /// the secondary mouse button
+    right,
 };
 
 /// Prints a #Mouse_button on a std::ostream. This function prints a