Fixed brief Doxygen description
parent
bf06998ece
commit
cf312c0b87
|
@ -28,7 +28,8 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \struct ApplicationPrivate Private data of CApplication class
|
* \struct ApplicationPrivate
|
||||||
|
* \brief Private data of CApplication class
|
||||||
*
|
*
|
||||||
* Contains SDL-specific variables that should not be visible outside application module.
|
* Contains SDL-specific variables that should not be visible outside application module.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -36,7 +36,8 @@ struct ApplicationPrivate;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \class CApplication Main application
|
* \class CApplication
|
||||||
|
* \brief Main application
|
||||||
*
|
*
|
||||||
* This class is responsible for creating and handling main application window,
|
* This class is responsible for creating and handling main application window,
|
||||||
* receiving events, etc.
|
* receiving events, etc.
|
||||||
|
|
|
@ -24,7 +24,8 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \enum SysDialogType Type of system dialog
|
* \enum SysDialogType
|
||||||
|
* \brief Type of system dialog
|
||||||
*/
|
*/
|
||||||
enum SystemDialogType
|
enum SystemDialogType
|
||||||
{
|
{
|
||||||
|
@ -41,7 +42,8 @@ enum SystemDialogType
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \enum SysDialogResult Result of system dialog
|
* \enum SysDialogResult
|
||||||
|
* \brief Result of system dialog
|
||||||
*
|
*
|
||||||
* Means which button was pressed.
|
* Means which button was pressed.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -26,7 +26,8 @@
|
||||||
|
|
||||||
namespace Gfx {
|
namespace Gfx {
|
||||||
|
|
||||||
/** \enum LightType Type of light */
|
/** \enum LightType
|
||||||
|
* \brief Type of light */
|
||||||
enum LightType
|
enum LightType
|
||||||
{
|
{
|
||||||
LT_Point,
|
LT_Point,
|
||||||
|
@ -35,7 +36,8 @@ enum LightType
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \struct Light Light
|
* \struct Light
|
||||||
|
* \brief Light
|
||||||
*
|
*
|
||||||
* This structure was created as analog to DirectX's D3DLIGHT.
|
* This structure was created as analog to DirectX's D3DLIGHT.
|
||||||
*
|
*
|
||||||
|
@ -81,7 +83,8 @@ struct LightProg
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \struct SceneLight Dynamic light in 3D scene
|
* \struct SceneLight
|
||||||
|
* \brief Dynamic light in 3D scene
|
||||||
*
|
*
|
||||||
* TODO documentation
|
* TODO documentation
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -22,7 +22,8 @@
|
||||||
namespace Gfx {
|
namespace Gfx {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \struct Material Material of a surface
|
* \struct Material
|
||||||
|
* \brief Material of a surface
|
||||||
*
|
*
|
||||||
* This structure was created as analog to DirectX's D3DMATERIAL.
|
* This structure was created as analog to DirectX's D3DMATERIAL.
|
||||||
*
|
*
|
||||||
|
|
|
@ -25,7 +25,8 @@
|
||||||
namespace Gfx {
|
namespace Gfx {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \struct Vertex Vertex of a primitive
|
* \struct Vertex
|
||||||
|
* \brief Vertex of a primitive
|
||||||
*
|
*
|
||||||
* This structure was created as analog to DirectX's D3DVERTEX.
|
* This structure was created as analog to DirectX's D3DVERTEX.
|
||||||
*
|
*
|
||||||
|
@ -47,7 +48,8 @@ struct Vertex
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \struct VertexTex2 Vertex with secondary texture coordinates
|
* \struct VertexTex2
|
||||||
|
* \brief Vertex with secondary texture coordinates
|
||||||
*
|
*
|
||||||
* In addition to fields from Gfx::Vector, it contains
|
* In addition to fields from Gfx::Vector, it contains
|
||||||
* secondary texture coordinates (u2, v2) as Math::Point
|
* secondary texture coordinates (u2, v2) as Math::Point
|
||||||
|
|
Loading…
Reference in New Issue