diff options
Diffstat (limited to 'src')
46 files changed, 234 insertions, 142 deletions
diff --git a/src/app/README.txt b/src/app/README.txt index 1df1fcc..e4f69ec 100644 --- a/src/app/README.txt +++ b/src/app/README.txt @@ -1,3 +1,4 @@ -src/app - -Contains the main class of the application. +/** + * \dir app + * Main class of the application and system functions + */ diff --git a/src/app/app.h b/src/app/app.h index d3b1368..bfa8c25 100644 --- a/src/app/app.h +++ b/src/app/app.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// app.h +/** + * \file app/app.h + * \brief CApplication class + */ #pragma once diff --git a/src/app/main.cpp b/src/app/main.cpp index dce13da..619043e 100644 --- a/src/app/main.cpp +++ b/src/app/main.cpp @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// main.cpp +/** + * \file app/main.cpp + * \brief Entry point of application - main() function + */ #include "app/app.h" #include "app/system.h" diff --git a/src/app/system.h b/src/app/system.h index 3c04760..e216842 100644 --- a/src/app/system.h +++ b/src/app/system.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// system.h +/** + * \file app/system.h + * \brief System functions: time stamps, info dialogs, etc. + */ #pragma once @@ -26,7 +29,7 @@ /* Dialog utils */ /** - * \enum SysDialogType + * \enum SystemDialogType * \brief Type of system dialog */ enum SystemDialogType @@ -44,7 +47,7 @@ enum SystemDialogType }; /** - * \enum SysDialogResult + * \enum SystemDialogResult * \brief Result of system dialog * * Means which button was pressed. diff --git a/src/app/system_linux.h b/src/app/system_linux.h index f58c9a1..69893de 100644 --- a/src/app/system_linux.h +++ b/src/app/system_linux.h @@ -15,10 +15,13 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// system_linux.h +/** + * \file app/system_linux.h + * \brief Linux-specific implementation of system functions + */ -/* This header contains Linux-specific code for system utils - from system.h. There is no separate .cpp module for simplicity.*/ +/* NOTE: code is contained in this header; + * there is no separate .cpp module for simplicity */ #include <sys/time.h> #include <time.h> diff --git a/src/app/system_other.h b/src/app/system_other.h index 9f13ffa..eff0c8a 100644 --- a/src/app/system_other.h +++ b/src/app/system_other.h @@ -15,10 +15,13 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// system_other.h +/** + * \file app/system_other.h + * \brief Fallback code for other systems + */ -/* This header contains fallback code for other platforms for system utils - from system.h. There is no separate .cpp module for simplicity.*/ +/* NOTE: code is contained in this header; + * there is no separate .cpp module for simplicity */ #include <SDL/SDL.h> diff --git a/src/app/system_windows.h b/src/app/system_windows.h index eb6beec..72d9f88 100644 --- a/src/app/system_windows.h +++ b/src/app/system_windows.h @@ -15,10 +15,13 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// system_windows.h +/** + * \file app/system_windows.h + * \brief Windows-specific implementation of system functions + */ -/* This header contains Windows-specific code for system utils - from system.h. There is no separate .cpp module for simplicity.*/ +/* NOTE: code is contained in this header; + * there is no separate .cpp module for simplicity */ #include <windows.h> diff --git a/src/common/README.txt b/src/common/README.txt index 36653cc..73d65b7 100644 --- a/src/common/README.txt +++ b/src/common/README.txt @@ -1,3 +1,4 @@ -src/common - -Contains headers and modules with common structs and enums. +/** + * \dir common + * \brief Structs and utils shared throughout the application + */ diff --git a/src/common/logger.h b/src/common/logger.h index a67aefe..5de3d63 100644 --- a/src/common/logger.h +++ b/src/common/logger.h @@ -57,36 +57,36 @@ class CLogger : public CSingleton<CLogger> ~CLogger(); /** Write message to console or file - * @param const char str - message to write + * @param str - message to write * @param ... - additional arguments */ void Message(const char *str, ...); /** Write message to console or file with LOG_INFO level - * @param const char str - message to write + * @param str - message to write * @param ... - additional arguments */ void Info(const char *str, ...); /** Write message to console or file with LOG_WARN level - * @param const char str - message to write + * @param str - message to write * @param ... - additional arguments */ void Warn(const char *str, ...); /** Write message to console or file with LOG_ERROR level - * @param const char str - message to write + * @param str - message to write * @param ... - additional arguments */ void Error(const char *str, ...); /** Set output file to write logs to - * @param std::string filename - output file to write to + * @param filename - output file to write to */ void SetOutputFile(std::string filename); /** Set log level. Logs with level below will not be shown - * @param LogType level - minimum log level to write + * @param level - minimum log level to write */ void SetLogLevel(LogType level); diff --git a/src/graphics/README.txt b/src/graphics/README.txt index 3ec3871..479747b 100644 --- a/src/graphics/README.txt +++ b/src/graphics/README.txt @@ -1,3 +1,12 @@ -src/graphics +/** + * \dir graphics + * \brief Graphics engine + */ -Graphics engine +/** + * \namespace Gfx + * \brief Namespace for (new) graphics code + * + * This namespace was created to avoid clashing with old code, but now it still serves, + * defining a border between pure graphics engine and other parts of application. + */
\ No newline at end of file diff --git a/src/graphics/core/README.txt b/src/graphics/core/README.txt index 12beef9..ca3768c 100644 --- a/src/graphics/core/README.txt +++ b/src/graphics/core/README.txt @@ -1,6 +1,7 @@ -src/graphics/core - -Abstract core of graphics engine - -Core types, enums, structs and CDevice abstract class that define -the abstract graphics device used in graphics engine +/** + * \dir graphics/core + * \brief Abstract core of graphics engine + * + * Core types, enums, structs and CDevice abstract class that define + * the abstract graphics device used in graphics engine + */
\ No newline at end of file diff --git a/src/graphics/core/color.h b/src/graphics/core/color.h index 0e08de3..ff8a2eb 100644 --- a/src/graphics/core/color.h +++ b/src/graphics/core/color.h @@ -14,7 +14,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// color.h +/** + * \file graphics/core/color.h + * \brief Color structs and related functions + */ #pragma once diff --git a/src/graphics/core/device.h b/src/graphics/core/device.h index d4fcd26..a829c81 100644 --- a/src/graphics/core/device.h +++ b/src/graphics/core/device.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// device.h +/** + * \file graphics/core/device.h + * \brief Abstract graphics device - Gfx::CDevice class and related structs/enums + */ #pragma once diff --git a/src/graphics/core/light.h b/src/graphics/core/light.h index b787cb2..a39d1f5 100644 --- a/src/graphics/core/light.h +++ b/src/graphics/core/light.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// light.h +/** + * \file graphics/core/light.h + * \brief Light struct and related enums + */ #pragma once diff --git a/src/graphics/core/material.h b/src/graphics/core/material.h index 31b42f3..eb73c50 100644 --- a/src/graphics/core/material.h +++ b/src/graphics/core/material.h @@ -14,7 +14,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// material.h +/** + * \file graphics/core/material.h + * \brief Material struct + */ #pragma once diff --git a/src/graphics/core/texture.h b/src/graphics/core/texture.h index bb5b52f..c36b6c6 100644 --- a/src/graphics/core/texture.h +++ b/src/graphics/core/texture.h @@ -14,7 +14,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// texture.h +/** + * \file graphics/core/texture.h + * \brief Texture struct and related enums + */ #pragma once diff --git a/src/graphics/core/vertex.h b/src/graphics/core/vertex.h index b7fab1c..53dd642 100644 --- a/src/graphics/core/vertex.h +++ b/src/graphics/core/vertex.h @@ -14,7 +14,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// vertex.h +/** + * \file graphics/core/vertex.h + * \brief Vertex structs + */ #pragma once diff --git a/src/graphics/d3d/README.txt b/src/graphics/d3d/README.txt index 8388120..524ae7b 100644 --- a/src/graphics/d3d/README.txt +++ b/src/graphics/d3d/README.txt @@ -1,3 +1,4 @@ -src/graphics/d3d - -Possible future DirectX implementation of graphics engine +/** + * \dir graphics/d3d + * \brief Possible future DirectX implementation of graphics engine + */
\ No newline at end of file diff --git a/src/graphics/engine/README.txt b/src/graphics/engine/README.txt index 308b601..f64d3dd 100644 --- a/src/graphics/engine/README.txt +++ b/src/graphics/engine/README.txt @@ -1,8 +1,9 @@ -src/graphics/engine - -Graphics engine - -CEngine class and various other classes implementing the main features -of graphics engine from model loading to decorative particles - -Graphics operations are done on abstract interface from src/graphics/core +/** + * \dir graphics/engine + * \brief Graphics engine + * + * CEngine class and various other classes implementing the main features + * of graphics engine from model loading to decorative particles + * + * Graphics operations are done on abstract interface from src/graphics/core + */
\ No newline at end of file diff --git a/src/graphics/engine/camera.h b/src/graphics/engine/camera.h index ec6afcb..1a82f9f 100644 --- a/src/graphics/engine/camera.h +++ b/src/graphics/engine/camera.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// camera.h +/** + * \file graphics/engine/camera.h + * \brief Camera handling - Gfx::CCamera class + */ #pragma once diff --git a/src/graphics/engine/cloud.h b/src/graphics/engine/cloud.h index 676dfe8..881a598 100644 --- a/src/graphics/engine/cloud.h +++ b/src/graphics/engine/cloud.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// cloud.h +/** + * \file graphics/engine/cloud.h + * \brief Cloud rendering - Gfx::CCloud class + */ #pragma once diff --git a/src/graphics/engine/engine.h b/src/graphics/engine/engine.h index 8f9338a..c7ff084 100644 --- a/src/graphics/engine/engine.h +++ b/src/graphics/engine/engine.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// engine.h +/** + * \file graphics/engine/engine.h + * \brief Main graphics engine - Gfx::CEngine class + */ #pragma once diff --git a/src/graphics/engine/lightman.h b/src/graphics/engine/lightman.h index 8272125..52058c8 100644 --- a/src/graphics/engine/lightman.h +++ b/src/graphics/engine/lightman.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// lightman.h +/** + * \file graphics/engine/lightman.h + * \brief Dynamic light manager - Gfx::CLightManager class + */ #pragma once diff --git a/src/graphics/engine/lightning.h b/src/graphics/engine/lightning.h index 9e854be..3b4e2cf 100644 --- a/src/graphics/engine/lightning.h +++ b/src/graphics/engine/lightning.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// lightning.h (aka blitz.h) +/** + * \file graphics/engine/lightning.h + * \brief Lightning rendering - Gfx::CLightning class (aka blitz) + */ #pragma once diff --git a/src/graphics/engine/modelfile.h b/src/graphics/engine/modelfile.h index 6a30487..fab190f 100644 --- a/src/graphics/engine/modelfile.h +++ b/src/graphics/engine/modelfile.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// modelfile.h (aka modfile.h) +/** + * \file graphics/engine/modelfile.h + * \brief Model loading - Gfx::CModelFile class (aka modfile) + */ #include "graphics/engine/engine.h" #include "graphics/core/vertex.h" diff --git a/src/graphics/engine/particle.h b/src/graphics/engine/particle.h index 89e2c5b..45396d2 100644 --- a/src/graphics/engine/particle.h +++ b/src/graphics/engine/particle.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// particle.h (aka particule.h) +/** + * \file graphics/engine/particle.h + * \brief Particle rendering - Gfx::CParticle class (aka particule) + */ #pragma once diff --git a/src/graphics/engine/planet.h b/src/graphics/engine/planet.h index 5ba318b..54d8b55 100644 --- a/src/graphics/engine/planet.h +++ b/src/graphics/engine/planet.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// planet.h +/** + * \file graphics/engine/planet.h + * \brief Planet rendering - Gfx::CPlanet class + */ #pragma once diff --git a/src/graphics/engine/pyro.h b/src/graphics/engine/pyro.h index 35b5c5f..768abf8 100644 --- a/src/graphics/engine/pyro.h +++ b/src/graphics/engine/pyro.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// pyro.h +/** + * \file graphics/engine/pyro.h + * \brief Fire effect rendering - Gfx::CPyro class + */ #pragma once diff --git a/src/graphics/engine/terrain.h b/src/graphics/engine/terrain.h index a198590..41d4bbb 100644 --- a/src/graphics/engine/terrain.h +++ b/src/graphics/engine/terrain.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// terrain.h +/** + * \file graphics/engine/terrain.h + * \brief Terrain rendering - Gfx::CTerrain class + */ #pragma once diff --git a/src/graphics/engine/text.h b/src/graphics/engine/text.h index 7e2f84b..24251ab 100644 --- a/src/graphics/engine/text.h +++ b/src/graphics/engine/text.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// text.h +/** + * \file graphics/engine/text.h + * \brief Text rendering - Gfx::CText class + */ #pragma once diff --git a/src/graphics/engine/water.h b/src/graphics/engine/water.h index 245baf7..b051889 100644 --- a/src/graphics/engine/water.h +++ b/src/graphics/engine/water.h @@ -15,7 +15,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// water.h +/** + * \file graphics/engine/water.h + * \brief Water rendering - Gfx::CWater class + */ #pragma once diff --git a/src/graphics/opengl/README.txt b/src/graphics/opengl/README.txt index 0aba0ed..596871d 100644 --- a/src/graphics/opengl/README.txt +++ b/src/graphics/opengl/README.txt @@ -1,6 +1,7 @@ -src/graphics/opengl - -OpenGL engine implementation - -Contains the concrete implementation using OpenGL of abstract CDevice class -from src/graphics/core +/** + * \dir graphics/opengl + * \brief OpenGL engine implementation + * + * Contains the concrete implementation using OpenGL of abstract CDevice class + * from src/graphics/core + */
\ No newline at end of file diff --git a/src/graphics/opengl/gldevice.h b/src/graphics/opengl/gldevice.h index a41c41c..dbe9a52 100644 --- a/src/graphics/opengl/gldevice.h +++ b/src/graphics/opengl/gldevice.h @@ -14,7 +14,10 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// gldevice.h +/** + * \file graphics/opengl/gldevice.h + * \brief OpenGL implementation - Gfx::CGLDevice class + */ #pragma once diff --git a/src/math/README.txt b/src/math/README.txt index 1a5ce93..fd34dcb 100644 --- a/src/math/README.txt +++ b/src/math/README.txt @@ -1,3 +1,12 @@ -src/math +/** + * \dir math + * \brief Common mathematical structures and functions + */ -Contains common mathematical structures and functions. +/** + * \namespace Math + * \brief Namespace for (new) math code + * + * This namespace was created to avoid clashing with old code, but now it still serves, + * defining a border between math and non-math-related code. + */
\ No newline at end of file diff --git a/src/math/all.h b/src/math/all.h index 13a9290..4ac9d55 100644 --- a/src/math/all.h +++ b/src/math/all.h @@ -14,14 +14,13 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -/** @defgroup MathAllModule math/all.h - Includes all other math module headers. +/** + * \file math/all.h + * \brief Includes all other math module headers */ #pragma once -/* @{ */ // start of group - #include "const.h" #include "func.h" #include "point.h" @@ -30,5 +29,3 @@ #include "geometry.h" #include "conv.h" - -/* @} */ // end of group diff --git a/src/math/const.h b/src/math/const.h index b08a400..0b6f971 100644 --- a/src/math/const.h +++ b/src/math/const.h @@ -14,8 +14,9 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -/** @defgroup MathConstModule math/const.h - Contains the math constants used in math functions. +/** + * \file math/const.h + * \brief Constants used in math functions */ #pragma once @@ -26,7 +27,6 @@ // Math module namespace namespace Math { -/* @{ */ // start of group //! Tolerance level -- minimum accepted float value const float TOLERANCE = 1e-6f; @@ -50,6 +50,5 @@ const float RAD_TO_DEG = 57.29577951308232286465f; //! Natural logarithm of 2 const float LOG_2 = log(2.0f); -/* @} */ // end of group }; // namespace Math diff --git a/src/math/func.h b/src/math/func.h index e97d990..541b084 100644 --- a/src/math/func.h +++ b/src/math/func.h @@ -15,8 +15,9 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -/** @defgroup MathFuncModule math/func.h - Contains common math functions. +/** + * \file math/func.h + * \brief Common math functions */ #pragma once @@ -31,8 +32,6 @@ namespace Math { -/* @{ */ // start of group - //! Compares \a a and \a b within \a tolerance inline bool IsEqual(float a, float b, float tolerance = Math::TOLERANCE) { @@ -188,11 +187,13 @@ inline float Direction(float a, float g) //! Managing the dead zone of a joystick. /** -\verbatimin: -1 0 1 +\verbatim +in: -1 0 1 --|-------|----o----|-------|--> <----> dead -out: -1 0 0 1\endverbatim */ +out: -1 0 0 1 +\endverbatim */ inline float Neutral(float value, float dead) { if ( fabs(value) <= dead ) @@ -226,7 +227,8 @@ inline float Smooth(float actual, float hope, float time) //! Bounces any movement /** -\verbatimout +\verbatim +out | 1+------o-------o--- | o | o o | | bounce @@ -235,7 +237,8 @@ inline float Smooth(float actual, float hope, float time) | o | | -o------|-------+----> progress 0| | 1 - |<---->|middle\endverbatim */ + |<---->|middle +\endverbatim */ inline float Bounce(float progress, float middle = 0.3f, float bounce = 0.4f) { if ( progress < middle ) @@ -250,6 +253,4 @@ inline float Bounce(float progress, float middle = 0.3f, float bounce = 0.4f) } } -/* @} */ // end of group - }; // namespace Math diff --git a/src/math/geometry.h b/src/math/geometry.h index 3a31ad6..1c5f60f 100644 --- a/src/math/geometry.h +++ b/src/math/geometry.h @@ -15,9 +15,9 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -/** @defgroup MathGeometryModule math/geometry.h - Contains math functions related to 3D geometry calculations, - transformations, etc. +/** + * \file math/geometry.h + * \brief Math functions related to 3D geometry calculations, transformations, etc. */ #pragma once @@ -36,9 +36,6 @@ namespace Math { -/* @{ */ // start of group - - //! Returns py up on the line \a a - \a b inline float MidPoint(const Math::Point &a, const Math::Point &b, float px) { @@ -566,6 +563,4 @@ inline Math::Vector RotateView(Math::Vector center, float angleH, float angleV, return eye+center; } -/* @} */ // end of group - }; // namespace Math diff --git a/src/math/intpoint.h b/src/math/intpoint.h index 476e67b..8e13b19 100644 --- a/src/math/intpoint.h +++ b/src/math/intpoint.h @@ -14,18 +14,18 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -/** @defgroup MathIntPointModule math/intpoint.h - Contains the IntPoint struct. +/** + * \file math/intpoint.h + * \brief IntPoint struct */ #pragma once namespace Math { -/* @{ */ // start of group - /** - * \struct IntPoint 2D Point with integer coords + * \struct IntPoint + * \brief 2D Point with integer coords * * Analog of WinAPI's POINT struct. */ @@ -39,6 +39,4 @@ struct IntPoint IntPoint(int aX = 0, int aY = 0) : x(aX), y(aY) {} }; -/* @} */ // end of group - }; // namespace Math diff --git a/src/math/matrix.h b/src/math/matrix.h index 45a7d75..30e629a 100644 --- a/src/math/matrix.h +++ b/src/math/matrix.h @@ -14,8 +14,9 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -/** @defgroup MathMatrixModule math/matrix.h - Contains the Matrix struct and related functions. +/** + * \file math/matrix.h + * \brief Matrix struct and related functions */ #pragma once @@ -32,8 +33,6 @@ namespace Math { -/* @{ */ // start of group - /** \struct Matrix math/matrix.h \brief 4x4 matrix @@ -42,11 +41,12 @@ namespace Math The internal representation is a 16-value table in column-major order, thus: - \verbatim +\verbatim m[0 ] m[4 ] m[8 ] m[12] m[1 ] m[5 ] m[9 ] m[13] m[2 ] m[6 ] m[10] m[14] -m[3 ] m[7 ] m[11] m[15] \endverbatim +m[3 ] m[7 ] m[11] m[15] +\endverbatim This representation is native to OpenGL; DirectX requires transposing the matrix. @@ -405,11 +405,15 @@ inline Math::Matrix MultiplyMatrices(const Math::Matrix &left, const Math::Matri } //! Calculates the result of multiplying m * v -/** The multiplication is performed thus: -\verbatim [ m.m[0 ] m.m[4 ] m.m[8 ] m.m[12] ] [ v.x ] +/** + The multiplication is performed thus: + +\verbatim +[ m.m[0 ] m.m[4 ] m.m[8 ] m.m[12] ] [ v.x ] [ m.m[1 ] m.m[5 ] m.m[9 ] m.m[13] ] [ v.y ] [ m.m[2 ] m.m[6 ] m.m[10] m.m[14] ] * [ v.z ] -[ m.m[3 ] m.m[7 ] m.m[11] m.m[15] ] [ 1 ] \endverbatim +[ m.m[3 ] m.m[7 ] m.m[11] m.m[15] ] [ 1 ] +\endverbatim The result, a 4x1 vector is then converted to 3x1 by dividing x,y,z coords by the fourth coord (w). */ @@ -434,6 +438,4 @@ inline Math::Vector MatrixVectorMultiply(const Math::Matrix &m, const Math::Vect return Math::Vector(x, y, z); } -/* @} */ // end of group - }; // namespace Math diff --git a/src/math/point.h b/src/math/point.h index ea20db9..ecf896f 100644 --- a/src/math/point.h +++ b/src/math/point.h @@ -14,8 +14,9 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -/** @defgroup MathPointModule math/point.h - Contains the Point struct and related functions. +/** + * \file math/point.h + * \brief Point struct and related functions */ #pragma once @@ -31,8 +32,6 @@ namespace Math { -/* @{ */ // start of group - /** \struct Point math/point.h \brief 2D point @@ -188,6 +187,4 @@ inline float Distance(const Point &a, const Point &b) return sqrtf((a.x-b.x)*(a.x-b.x) + (a.y-b.y)*(a.y-b.y)); } -/* @} */ // end of group - }; // namespace Math diff --git a/src/math/vector.h b/src/math/vector.h index 147869f..4378e75 100644 --- a/src/math/vector.h +++ b/src/math/vector.h @@ -14,8 +14,9 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -/** @defgroup MathVectorModule math/vector.h - Contains the Vector struct and related functions. +/** + * \file math/vector.h + * \brief Vector struct and related functions */ #pragma once @@ -31,8 +32,6 @@ namespace Math { -/* @{ */ // start of group - /** \struct Vector math/vector.h \brief 3D (3x1) vector @@ -263,6 +262,4 @@ inline float Distance(const Math::Vector &a, const Math::Vector &b) (a.z-b.z)*(a.z-b.z) ); } -/* @} */ // end of group - }; // namespace Math diff --git a/src/object/README.txt b/src/object/README.txt index f4c25d0..f3bad23 100644 --- a/src/object/README.txt +++ b/src/object/README.txt @@ -1,3 +1,7 @@ -src/object - -Contains modules of robots and buildings. +/** + * \dir object + * \brief Game engine + * + * Contains the main class of game engine - CRobotMain and the various in-game objects: + * CObject and related auto, motion and task subclasses. + */
\ No newline at end of file diff --git a/src/physics/README.txt b/src/physics/README.txt index 0003956..4ad5989 100644 --- a/src/physics/README.txt +++ b/src/physics/README.txt @@ -1,3 +1,4 @@ -src/physics - -Contains the physics module. +/** + * \dir physics + * \brief Physics engine + */
\ No newline at end of file diff --git a/src/sound/README.txt b/src/sound/README.txt index d6ac0bd..fa7bbad 100644 --- a/src/sound/README.txt +++ b/src/sound/README.txt @@ -1,3 +1,4 @@ -src/sound - -Contains the sound module - for playing sounds and music. +/** + * \dir sound + * \brief Sound module - playing sounds and music + */
\ No newline at end of file diff --git a/src/ui/README.txt b/src/ui/README.txt index 4ffd8ec..9814ef0 100644 --- a/src/ui/README.txt +++ b/src/ui/README.txt @@ -1,3 +1,4 @@ -src/ui - -Contains modules responsible for displaying the user interface controls (from game menus and HUD). +/** + * \dir ui + * \brief 2D user interface controls + */
\ No newline at end of file |