Added Doxygen comment stubs

This commit is contained in:
2006-07-04 02:41:31 -04:00
parent 8fb1a468ac
commit dc565ce1dc
28 changed files with 4500 additions and 13 deletions

View File

@@ -4,6 +4,18 @@
#include "list.h"
namespace OpenArena{
/*!
* \brief
* Write brief comment for ControlScheme here.
*
* Write detailed description for ControlScheme here.
*
* \remarks
* Write remarks for ControlScheme here.
*
* \see
* Separate items with the '|' character.
*/
class ControlScheme
{
public:
@@ -12,9 +24,81 @@ namespace OpenArena{
ACTION_ROLLLEFT, ACTION_ROLLRIGHT, ACTION_FIREPRIMARY, ACTION_FIRESECONDARY,
ACTION_WEAPONNEXT, ACTION_WEAPONPREV, ACTION_TOGGLE_LIGHTS, ACTION_TOGGLE_FPS,
ACTION_TOGGLE_CONSOLE, ACTION_TOGGLE_MOUSELOOK, ACTION_QUICKMOUSELOOK};
/*!
* \brief
* Write brief comment for LoadDefaultControlScheme here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for LoadDefaultControlScheme here.
*
* \remarks
* Write remarks for LoadDefaultControlScheme here.
*
* \see
* Separate items with the '|' character.
*/
void LoadDefaultControlScheme();
/*!
* \brief
* Write brief comment for ClearControlScheme here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ClearControlScheme here.
*
* \remarks
* Write remarks for ClearControlScheme here.
*
* \see
* Separate items with the '|' character.
*/
void ClearControlScheme();
/*!
* \brief
* Write brief comment for Unbind here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Unbind here.
*
* \remarks
* Write remarks for Unbind here.
*
* \see
* Separate items with the '|' character.
*/
void Unbind(uint8);
/*!
* \brief
* Write brief comment for Bind here.
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Bind here.
*
* \remarks
* Write remarks for Bind here.
*
* \see
* Separate items with the '|' character.
*/
bool Bind(uint32, uint8);
list<uint8> forward;