Tweak/punctuate/add doxygen comments in menu.h and menu.cc.

1 files changed, 31 insertions, 31 deletions

diff --git a/crawl-ref/source/menu.h b/crawl-ref/source/menu.h
index 802be39f73..03018ef38f 100644
--- a/crawl-ref/source/menu.h
+++ b/crawl-ref/source/menu.h
@@ -236,25 +236,25 @@ public:
 
 enum MenuFlag
 {
-    MF_NOSELECT         = 0x0000,   // No selection is permitted
-    MF_SINGLESELECT     = 0x0001,   // Select just one item
-    MF_MULTISELECT      = 0x0002,   // Select multiple items
-    MF_NO_SELECT_QTY    = 0x0004,   // Disallow partial selections
-    MF_ANYPRINTABLE     = 0x0008,   // Any printable character is valid, and
-                                    // closes the menu.
-    MF_SELECT_BY_PAGE   = 0x0010,   // Allow selections to occur only on
-                                    // currently visible page.
-
-    MF_ALWAYS_SHOW_MORE = 0x0020,   // Always show the -more- footer
-    MF_NOWRAP           = 0x0040,   // Paging past the end will not wrap back.
-
-    MF_ALLOW_FILTER     = 0x0080,   // Control-F will ask for regex and
-                                    // select the appropriate items.
-    MF_ALLOW_FORMATTING = 0x0100,   // Parse index for formatted-string
-    MF_SHOW_PAGENUMBERS = 0x0200,   // Show "(page X of Y)" when appropriate
+    MF_NOSELECT         = 0x0000,   /// No selection is permitted
+    MF_SINGLESELECT     = 0x0001,   /// Select just one item
+    MF_MULTISELECT      = 0x0002,   /// Select multiple items
+    MF_NO_SELECT_QTY    = 0x0004,   /// Disallow partial selections
+    MF_ANYPRINTABLE     = 0x0008,   /// Any printable character is valid, and
+                                    /// closes the menu.
+    MF_SELECT_BY_PAGE   = 0x0010,   /// Allow selections to occur only on
+                                    /// currently visible page.
+
+    MF_ALWAYS_SHOW_MORE = 0x0020,   /// Always show the -more- footer
+    MF_NOWRAP           = 0x0040,   /// Paging past the end will not wrap back.
+
+    MF_ALLOW_FILTER     = 0x0080,   /// Control-F will ask for regex and
+                                    /// select the appropriate items.
+    MF_ALLOW_FORMATTING = 0x0100,   /// Parse index for formatted-string
+    MF_SHOW_PAGENUMBERS = 0x0200,   /// Show "(page X of Y)" when appropriate
     MF_EASY_EXIT        = 0x1000,
     MF_START_AT_END     = 0x2000,
-    MF_PRESELECTED      = 0x4000,   // Has a preselected entry.
+    MF_PRESELECTED      = 0x4000,   /// Has a preselected entry.
 };
 
 class MenuDisplay
@@ -442,7 +442,7 @@ protected:
     virtual bool process_key(int keyin);
 };
 
-// Allows toggling by specific keys.
+/// Allows toggling by specific keys.
 class ToggleableMenu : public Menu
 {
 public:
@@ -526,11 +526,11 @@ protected:
 };
 
 /**
- * Written by Janne "felirx" Lahdenpera
- * Abstract base class interface for all menu items to inherit from
- * each item should know how it's rendered.
- * rendering should only check the item bounds and screen bounds to prevent
- * assertion errors
+ * @author Janne "felirx" Lahdenpera
+ * Abstract base class interface for all menu items to inherit from.
+ * Each item should know how it's rendered.
+ * Rendering should only check the item bounds and screen bounds to prevent
+ * assertion errors.
  */
 class MenuItem
 {
@@ -642,7 +642,7 @@ protected:
 };
 
 /**
- * Behaves the same as TextItem, expect selection has been overridden to always
+ * Behaves the same as TextItem, except selection has been overridden to always
  * return false
  */
 class NoSelectTextItem : public TextItem
@@ -711,10 +711,10 @@ protected:
 class PrecisionMenu;
 
 /**
- * Abstract base class interface for all attachable objects
+ * Abstract base class interface for all attachable objects.
  * Objects are generally containers that hold MenuItems, however special
  * objects are also possible, for instance MenuDescriptor, MenuButton.
- * All objects should have an unique std::string name, although the uniquitity
+ * All objects should have an unique std::string #name, although the uniqueness
  * is not enforced or checked right now.
  */
 class MenuObject
@@ -883,8 +883,8 @@ protected:
 };
 
 /**
- * Base class for various descriptor and highlighter objects
- * these should probably be attached last to the menu to be rendered last
+ * Base class for various descriptor and highlighter objects.
+ * These should probably be attached last to the menu to be rendered last.
  */
 class MenuDescriptor : public MenuObject
 {
@@ -955,8 +955,8 @@ protected:
 };
 
 /**
- * Highlighter object
- * TILES: It will create a colored rectangle around the currently active item
+ * Highlighter object.
+ * TILES: It will create a colored rectangle around the currently active item.
  * CONSOLE: It will muck with the Item background color, setting it to highlight
  *          colour, reverting the change when active changes.
  */
@@ -1026,7 +1026,7 @@ protected:
 };
 
 /**
- * Base operations for a button to work
+ * Base operations for a button to work.
  * TODO: implement
  */
 class MenuButton : public MenuObject