From 619f44347cb047f0b0368aa44ea7c61a6038d791 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 16 Sep 2012 21:57:08 +0200 Subject: [PATCH] Doxygen documentation workarounds. --- src/Math/Geometry/Distance.h | 12 ++++-------- src/Math/Geometry/Intersection.h | 6 ++---- src/Math/Matrix.h | 20 ++++++++------------ src/Math/Matrix3.h | 2 +- src/Math/Matrix4.h | 2 +- src/Math/Vector4.h | 1 - 6 files changed, 16 insertions(+), 27 deletions(-) diff --git a/src/Math/Geometry/Distance.h b/src/Math/Geometry/Distance.h index 143ab8784..b86b5aa71 100644 --- a/src/Math/Geometry/Distance.h +++ b/src/Math/Geometry/Distance.h @@ -33,8 +33,7 @@ class Distance { * @param point Point * * The distance *d* is computed from point **p** and line defined by **a** - * and **b** using @ref Vector3::cross() "cross product": - * @f[ + * and **b** using @ref Vector3::cross() "cross product": @f[ * d = \frac{|(\boldsymbol p - \boldsymbol a) \times (\boldsymbol p - \boldsymbol b)|} * {|\boldsymbol b - \boldsymbol a|} * @f] @@ -66,19 +65,16 @@ class Distance { * * Determining whether the point lies next to line segment or outside * is done using Pythagorean theorem. If the following equation - * applies, the point **p** lies outside line segment closer to **a**: - * @f[ + * applies, the point **p** lies outside line segment closer to **a**: @f[ * |\boldsymbol p - \boldsymbol b|^2 > |\boldsymbol b - \boldsymbol a|^2 + |\boldsymbol p - \boldsymbol a|^2 * @f] * On the other hand, if the following equation applies, the point - * lies outside line segment closer to **b**: - * @f[ + * lies outside line segment closer to **b**: @f[ * |\boldsymbol p - \boldsymbol a|^2 > |\boldsymbol b - \boldsymbol a|^2 + |\boldsymbol p - \boldsymbol b|^2 * @f] * The last alternative is when the following equation applies. The * point then lies between **a** and **b** and the distance is - * computed the same way as in linePoint(). - * @f[ + * computed the same way as in linePoint(). @f[ * |\boldsymbol b - \boldsymbol a|^2 > |\boldsymbol p - \boldsymbol a|^2 + |\boldsymbol p - \boldsymbol b|^2 * @f] * diff --git a/src/Math/Geometry/Intersection.h b/src/Math/Geometry/Intersection.h index b4cee3f72..6eeba75bc 100644 --- a/src/Math/Geometry/Intersection.h +++ b/src/Math/Geometry/Intersection.h @@ -39,14 +39,12 @@ class Intersection { * is inside the line segment defined by `a` and `b`. * * First the parameter *f* of parametric equation of the plane - * is computed from plane normal **n** and plane position: - * @f[ + * is computed from plane normal **n** and plane position: @f[ * \begin{pmatrix} n_0 \\ n_1 \\ n_2 \end{pmatrix} \cdot * \begin{pmatrix} x \\ y \\ z \end{pmatrix} - f = 0 * @f] * Using plane normal **n**, parameter *f* and points **a** and **b**, - * value of *t* is computed and returned. - * @f[ + * value of *t* is computed and returned. @f[ * \begin{array}{rcl} * \Delta \boldsymbol b & = & \boldsymbol b - \boldsymbol a \\ * f & = & \boldsymbol n \cdot (\boldsymbol a + \Delta \boldsymbol b \cdot t) \\ diff --git a/src/Math/Matrix.h b/src/Math/Matrix.h index 30e6c1e2e..e799591da 100644 --- a/src/Math/Matrix.h +++ b/src/Math/Matrix.h @@ -69,7 +69,7 @@ template class Matrix: public RectangularMatrix { (*this)(i, i) = value; } - /** @copydoc RectangularMatrix::RectangularMatrix(T, U...) */ + /** @copydoc RectangularMatrix::RectangularMatrix */ #ifndef DOXYGEN_GENERATING_OUTPUT template inline constexpr Matrix(T first, U... next): RectangularMatrix(first, next...) {} #else @@ -115,15 +115,12 @@ template class Matrix: public RectangularMatrix { /** * @brief Determinant * - * Computed recursively using Laplace's formula: - * @f[ - * \det(A) = \sum_{j=1}^n (-1)^{i+j} a_{i,j} \det(A^{i,j}) - * @f] - * @f$ A^{i, j} @f$ is matrix without i-th row and j-th column, see + * Computed recursively using Laplace's formula: @f[ + * \det(A) = \sum_{j=1}^n (-1)^{i+j} a_{i,j} \det(A^{i,j}) + * @f] @f$ A^{i, j} @f$ is matrix without i-th row and j-th column, see * ij(). The formula is expanded down to 2x2 matrix, where the - * determinant is computed directly: - * @f[ - * \det(A) = a_{0, 0} a_{1, 1} - a_{1, 0} a_{0, 1} + * determinant is computed directly: @f[ + * \det(A) = a_{0, 0} a_{1, 1} - a_{1, 0} a_{0, 1} * @f] */ inline T determinant() const { return Implementation::MatrixDeterminant()(*this); } @@ -131,9 +128,8 @@ template class Matrix: public RectangularMatrix { /** * @brief Inverted matrix * - * Computed using Cramer's rule: - * @f[ - * A^{-1} = \frac{1}{\det(A)} Adj(A) + * Computed using Cramer's rule: @f[ + * A^{-1} = \frac{1}{\det(A)} Adj(A) * @f] */ Matrix inverted() const { diff --git a/src/Math/Matrix3.h b/src/Math/Matrix3.h index fd2af1d4d..09dacfddb 100644 --- a/src/Math/Matrix3.h +++ b/src/Math/Matrix3.h @@ -86,7 +86,7 @@ template class Matrix3: public Matrix<3, T> { T(0), T(0), value ) {} - /** @copydoc Matrix::Matrix(T, U...) */ + /** @copydoc Matrix::Matrix */ #ifndef DOXYGEN_GENERATING_OUTPUT template inline constexpr Matrix3(T first, U... next): Matrix<3, T>(first, next...) {} #else diff --git a/src/Math/Matrix4.h b/src/Math/Matrix4.h index 2e10dda97..487a6baa9 100644 --- a/src/Math/Matrix4.h +++ b/src/Math/Matrix4.h @@ -116,7 +116,7 @@ template class Matrix4: public Matrix<4, T> { T(0), T(0), T(0), value ) {} - /** @copydoc Matrix::Matrix(T, U...) */ + /** @copydoc Matrix::Matrix */ #ifndef DOXYGEN_GENERATING_OUTPUT template inline constexpr Matrix4(T first, U... next): Matrix<4, T>(first, next...) {} #else diff --git a/src/Math/Vector4.h b/src/Math/Vector4.h index 41e24f313..2111e744e 100644 --- a/src/Math/Vector4.h +++ b/src/Math/Vector4.h @@ -34,7 +34,6 @@ template class Vector4: public Vector<4, T> { public: /** * @copydoc Vector::Vector - * * W component is set to one. */ inline constexpr Vector4(): Vector<4, T>(T(0), T(0), T(0), T(1)) {}