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

@@ -9,9 +9,36 @@ enum { //Begin entity declaration
ENTITY_PLAYER_MULTI_START //Player start position for multiplayer.
}; //End entity declaration
/*!
* \brief
* Write brief comment for ENTITY here.
*
* Write detailed description for ENTITY here.
*
* \remarks
* Write remarks for ENTITY here.
*
* \see
* Separate items with the '|' character.
*/
class ENTITY
{
public:
/*!
* \brief
* Write brief comment for ENTITY here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ENTITY here.
*
* \remarks
* Write remarks for ENTITY here.
*
* \see
* Separate items with the '|' character.
*/
ENTITY()
{
type = ENTITY_NONE;