Added Doxygen comment stubs
This commit is contained in:
31
src/Plugin.h
31
src/Plugin.h
@@ -2,10 +2,41 @@
|
||||
|
||||
namespace OpenArena
|
||||
{
|
||||
/*!
|
||||
* \brief
|
||||
* Write brief comment for Plugin here.
|
||||
*
|
||||
* Write detailed description for Plugin here.
|
||||
*
|
||||
* \remarks
|
||||
* Write remarks for Plugin here.
|
||||
*
|
||||
* \see
|
||||
* Separate items with the '|' character.
|
||||
*/
|
||||
class Plugin
|
||||
{
|
||||
public:
|
||||
/*!
|
||||
* \brief
|
||||
* Write brief comment for ~Plugin here.
|
||||
*
|
||||
* \throws <exception class>
|
||||
* Description of criteria for throwing this exception.
|
||||
*
|
||||
* Write detailed description for ~Plugin here.
|
||||
*
|
||||
* \remarks
|
||||
* Write remarks for ~Plugin here.
|
||||
*
|
||||
* \see
|
||||
* Separate items with the '|' character.
|
||||
*/
|
||||
virtual ~Plugin(void){}
|
||||
/*!
|
||||
* \brief
|
||||
* Write brief comment for InputPlugin here.
|
||||
*/
|
||||
enum Type {VideoPlugin, AudioPlugin, InputPlugin};
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user