summaryrefslogtreecommitdiffstats
path: root/crawl-ref/source/menu.h
diff options
context:
space:
mode:
authorNeil Moore <neil@s-z.org>2014-03-19 03:06:50 -0400
committerNeil Moore <neil@s-z.org>2014-03-19 03:06:50 -0400
commitf173aa4c964642e553a68d4ba2b2b885f8ccbe29 (patch)
tree5c6810de7cf39731a97683e4e6ef8073d0599b0a /crawl-ref/source/menu.h
parent9e04ae6d8e5de4db1a9b565c07997a33414ebb2d (diff)
downloadcrawl-ref-f173aa4c964642e553a68d4ba2b2b885f8ccbe29.tar.gz
crawl-ref-f173aa4c964642e553a68d4ba2b2b885f8ccbe29.zip
Improve doxygen tagging of an enum.
Diffstat (limited to 'crawl-ref/source/menu.h')
-rw-r--r--crawl-ref/source/menu.h42
1 files changed, 20 insertions, 22 deletions
diff --git a/crawl-ref/source/menu.h b/crawl-ref/source/menu.h
index 44f9448ea9..343d222096 100644
--- a/crawl-ref/source/menu.h
+++ b/crawl-ref/source/menu.h
@@ -251,28 +251,26 @@ 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_TOGGLE_ACTION = 0x0400, /// ToggleableMenu toggles action as well
- MF_EASY_EXIT = 0x1000,
- MF_START_AT_END = 0x2000,
- MF_PRESELECTED = 0x4000, /// Has a preselected entry.
- MF_QUIET_SELECT = 0x8000, /// No selection box and no count.
- MF_DROP_PICKUP = 0x10000, /// Show inventory weights by default
+ 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_TOGGLE_ACTION = 0x0400, ///< ToggleableMenu toggles action as well
+ MF_EASY_EXIT = 0x1000, ///< Exit when scrolling off the end
+ MF_START_AT_END = 0x2000, ///< Scroll to end of list
+ MF_PRESELECTED = 0x4000, ///< Has a preselected entry.
+ MF_QUIET_SELECT = 0x8000, ///< No selection box and no count.
+ MF_DROP_PICKUP = 0x10000, ///< Show inventory weights by default
};
class MenuDisplay