From cf312c0b870175b8897ce98df6a8c46ccce92e2e Mon Sep 17 00:00:00 2001 From: Piotr Dziwinski Date: Tue, 26 Jun 2012 22:50:55 +0200 Subject: [PATCH] Fixed brief Doxygen description --- src/app/app.cpp | 3 ++- src/app/app.h | 3 ++- src/app/system.h | 6 ++++-- src/graphics/common/light.h | 9 ++++++--- src/graphics/common/material.h | 3 ++- src/graphics/common/vertex.h | 6 ++++-- 6 files changed, 20 insertions(+), 10 deletions(-) diff --git a/src/app/app.cpp b/src/app/app.cpp index 466d757f..3ce8d7ac 100644 --- a/src/app/app.cpp +++ b/src/app/app.cpp @@ -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. */ diff --git a/src/app/app.h b/src/app/app.h index a58ea986..e83652ca 100644 --- a/src/app/app.h +++ b/src/app/app.h @@ -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, * receiving events, etc. diff --git a/src/app/system.h b/src/app/system.h index 95571a2c..3bf6457e 100644 --- a/src/app/system.h +++ b/src/app/system.h @@ -24,7 +24,8 @@ /** - * \enum SysDialogType Type of system dialog + * \enum SysDialogType + * \brief Type of system dialog */ 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. */ diff --git a/src/graphics/common/light.h b/src/graphics/common/light.h index 1d14c5bc..dec99121 100644 --- a/src/graphics/common/light.h +++ b/src/graphics/common/light.h @@ -26,7 +26,8 @@ namespace Gfx { -/** \enum LightType Type of light */ +/** \enum LightType + * \brief Type of light */ enum LightType { 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. * @@ -81,7 +83,8 @@ struct LightProg }; /** - * \struct SceneLight Dynamic light in 3D scene + * \struct SceneLight + * \brief Dynamic light in 3D scene * * TODO documentation */ diff --git a/src/graphics/common/material.h b/src/graphics/common/material.h index 2ec2e1b8..f71923f9 100644 --- a/src/graphics/common/material.h +++ b/src/graphics/common/material.h @@ -22,7 +22,8 @@ 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. * diff --git a/src/graphics/common/vertex.h b/src/graphics/common/vertex.h index b6204139..0cc64021 100644 --- a/src/graphics/common/vertex.h +++ b/src/graphics/common/vertex.h @@ -25,7 +25,8 @@ 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. * @@ -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 * secondary texture coordinates (u2, v2) as Math::Point