diff --git a/src/ScreenSelect.h b/src/ScreenSelect.h index efdc9e92ab..af2cb62f63 100644 --- a/src/ScreenSelect.h +++ b/src/ScreenSelect.h @@ -1,4 +1,4 @@ -/* ScreenSelect - Base class for Style, Difficulty, and Mode selection screens. */ +/** @brief ScreenSelect - Base class for Style, Difficulty, and Mode selection screens. */ #ifndef SCREEN_SELECT_H #define SCREEN_SELECT_H @@ -25,12 +25,18 @@ protected: virtual int GetSelectionIndex( PlayerNumber pn ) = 0; virtual void UpdateSelectableChoices() = 0; // derived screens must handle this - vector m_aGameCommands; // derived classes should look here for what choices are available + /** + * @brief The game commands available. + * + * Derived classes should look here for the choices. */ + vector m_aGameCommands; vector m_asSubscribedMessages; - RageTimer m_timerIdleComment; // count up to time between idle comment announcer sounds - RageTimer m_timerIdleTimeout; // count up to go to the timeout screen + /** @brief Count up to the time between idle comment announcer sounds. */ + RageTimer m_timerIdleComment; + /** @brief Count up to go to the timeout screen. */ + RageTimer m_timerIdleTimeout; ThemeMetric IDLE_COMMENT_SECONDS; ThemeMetric IDLE_TIMEOUT_SECONDS; @@ -39,8 +45,10 @@ protected: #endif -/* - * (c) 2001-2004 Chris Danford +/** + * @file + * @author Chris Danford (c) 2001-2004 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a