diff options
Diffstat (limited to 'include/ui_quest.hpp')
| -rw-r--r-- | include/ui_quest.hpp | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/include/ui_quest.hpp b/include/ui_quest.hpp index 8582b67..d770011 100644 --- a/include/ui_quest.hpp +++ b/include/ui_quest.hpp @@ -1,3 +1,8 @@ +/** + * @file ui_quest.hpp + * @brief Handles UI elements related to quests. + */ + #ifndef UI_QUEST_HPP_ #define UI_QUEST_HPP_ @@ -6,12 +11,20 @@ namespace ui { namespace quest { + /** + * A flag to determine if the UI should be drawn. + */ bool _toggle = false; - void toggle(void) { - _toggle ^= true; - } + /** + * Toggles displaying of the UI. + */ + inline void toggle(void) + { _toggle ^= true; } + /** + * Draws the quest UI to the screen, if enabled. + */ void draw(void) { static unsigned int textWrap = 40; |