diff options
| author | Piotr Dziwinski <piotrdz@gmail.com> | 2012-09-27 20:43:20 +0200 |
|---|---|---|
| committer | Piotr Dziwinski <piotrdz@gmail.com> | 2012-09-27 20:43:20 +0200 |
| commit | a394c9efec830b275c0b738974126aead284ec4e (patch) | |
| tree | fbe57b44efdaf41eeae1a8a870407e4ea837786f /src/math | |
| parent | 2ef1c8b6f8976c2c11034a6d30d941e5b22bfac0 (diff) | |
| download | colobot-a394c9efec830b275c0b738974126aead284ec4e.tar.gz colobot-a394c9efec830b275c0b738974126aead284ec4e.tar.bz2 colobot-a394c9efec830b275c0b738974126aead284ec4e.zip | |
Updated docs and some Doxygen fixes
Diffstat (limited to 'src/math')
| -rw-r--r-- | src/math/README.txt | 4 | ||||
| -rw-r--r-- | src/math/geometry.h | 5 |
2 files changed, 6 insertions, 3 deletions
diff --git a/src/math/README.txt b/src/math/README.txt index fd34dcb..26069aa 100644 --- a/src/math/README.txt +++ b/src/math/README.txt @@ -1,5 +1,5 @@ /** - * \dir math + * \dir src/math * \brief Common mathematical structures and functions */ @@ -9,4 +9,4 @@ * * 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/geometry.h b/src/math/geometry.h index f086e2d..ee6fc52 100644 --- a/src/math/geometry.h +++ b/src/math/geometry.h @@ -237,6 +237,7 @@ inline float RotateAngle(const Math::Point ¢er, const Math::Point &p1, const //! Loads view matrix from the given vectors /** + * \param mat result matrix * \param from origin * \param at view direction * \param worldUp up vector @@ -304,6 +305,7 @@ inline void LoadViewMatrix(Math::Matrix &mat, const Math::Vector &from, //! Loads a perspective projection matrix /** + * \param mat result matrix * \param fov field of view in radians * \param aspect aspect ratio (width / height) * \param nearPlane distance to near cut plane @@ -328,6 +330,7 @@ inline void LoadProjectionMatrix(Math::Matrix &mat, float fov = Math::PI / 2.0f, //! Loads an othogonal projection matrix /** + * \param mat result matrix * \param left,right coordinates for left and right vertical clipping planes * \param bottom,top coordinates for bottom and top horizontal clipping planes * \param zNear,zFar distance to nearer and farther depth clipping planes @@ -590,7 +593,7 @@ inline Math::Vector Transform(const Math::Matrix &m, const Math::Vector &p) //! Calculates the projection of the point \a p on a straight line \a a to \a b /** - * \param point to project + * \param p point to project * \param a,b two ends of the line */ inline Math::Vector Projection(const Math::Vector &a, const Math::Vector &b, const Math::Vector &p) |