Browse Source

Doxygen documentation workarounds.

pull/279/head
Vladimír Vondruš 14 years ago
parent
commit
619f44347c
  1. 12
      src/Math/Geometry/Distance.h
  2. 6
      src/Math/Geometry/Intersection.h
  3. 20
      src/Math/Matrix.h
  4. 2
      src/Math/Matrix3.h
  5. 2
      src/Math/Matrix4.h
  6. 1
      src/Math/Vector4.h

12
src/Math/Geometry/Distance.h

@ -33,8 +33,7 @@ class Distance {
* @param point Point * @param point Point
* *
* The distance *d* is computed from point **p** and line defined by **a** * The distance *d* is computed from point **p** and line defined by **a**
* and **b** using @ref Vector3::cross() "cross product": * and **b** using @ref Vector3::cross() "cross product": @f[
* @f[
* d = \frac{|(\boldsymbol p - \boldsymbol a) \times (\boldsymbol p - \boldsymbol b)|} * d = \frac{|(\boldsymbol p - \boldsymbol a) \times (\boldsymbol p - \boldsymbol b)|}
* {|\boldsymbol b - \boldsymbol a|} * {|\boldsymbol b - \boldsymbol a|}
* @f] * @f]
@ -66,19 +65,16 @@ class Distance {
* *
* Determining whether the point lies next to line segment or outside * Determining whether the point lies next to line segment or outside
* is done using Pythagorean theorem. If the following equation * is done using Pythagorean theorem. If the following equation
* applies, the point **p** lies outside line segment closer to **a**: * applies, the point **p** lies outside line segment closer to **a**: @f[
* @f[
* |\boldsymbol p - \boldsymbol b|^2 > |\boldsymbol b - \boldsymbol a|^2 + |\boldsymbol p - \boldsymbol a|^2 * |\boldsymbol p - \boldsymbol b|^2 > |\boldsymbol b - \boldsymbol a|^2 + |\boldsymbol p - \boldsymbol a|^2
* @f] * @f]
* On the other hand, if the following equation applies, the point * On the other hand, if the following equation applies, the point
* lies outside line segment closer to **b**: * lies outside line segment closer to **b**: @f[
* @f[
* |\boldsymbol p - \boldsymbol a|^2 > |\boldsymbol b - \boldsymbol a|^2 + |\boldsymbol p - \boldsymbol b|^2 * |\boldsymbol p - \boldsymbol a|^2 > |\boldsymbol b - \boldsymbol a|^2 + |\boldsymbol p - \boldsymbol b|^2
* @f] * @f]
* The last alternative is when the following equation applies. The * The last alternative is when the following equation applies. The
* point then lies between **a** and **b** and the distance is * point then lies between **a** and **b** and the distance is
* computed the same way as in linePoint(). * computed the same way as in linePoint(). @f[
* @f[
* |\boldsymbol b - \boldsymbol a|^2 > |\boldsymbol p - \boldsymbol a|^2 + |\boldsymbol p - \boldsymbol b|^2 * |\boldsymbol b - \boldsymbol a|^2 > |\boldsymbol p - \boldsymbol a|^2 + |\boldsymbol p - \boldsymbol b|^2
* @f] * @f]
* *

6
src/Math/Geometry/Intersection.h

@ -39,14 +39,12 @@ class Intersection {
* is inside the line segment defined by `a` and `b`. * is inside the line segment defined by `a` and `b`.
* *
* First the parameter *f* of parametric equation of the plane * First the parameter *f* of parametric equation of the plane
* is computed from plane normal **n** and plane position: * is computed from plane normal **n** and plane position: @f[
* @f[
* \begin{pmatrix} n_0 \\ n_1 \\ n_2 \end{pmatrix} \cdot * \begin{pmatrix} n_0 \\ n_1 \\ n_2 \end{pmatrix} \cdot
* \begin{pmatrix} x \\ y \\ z \end{pmatrix} - f = 0 * \begin{pmatrix} x \\ y \\ z \end{pmatrix} - f = 0
* @f] * @f]
* Using plane normal **n**, parameter *f* and points **a** and **b**, * Using plane normal **n**, parameter *f* and points **a** and **b**,
* value of *t* is computed and returned. * value of *t* is computed and returned. @f[
* @f[
* \begin{array}{rcl} * \begin{array}{rcl}
* \Delta \boldsymbol b & = & \boldsymbol b - \boldsymbol a \\ * \Delta \boldsymbol b & = & \boldsymbol b - \boldsymbol a \\
* f & = & \boldsymbol n \cdot (\boldsymbol a + \Delta \boldsymbol b \cdot t) \\ * f & = & \boldsymbol n \cdot (\boldsymbol a + \Delta \boldsymbol b \cdot t) \\

20
src/Math/Matrix.h

@ -69,7 +69,7 @@ template<size_t s, class T> class Matrix: public RectangularMatrix<s, s, T> {
(*this)(i, i) = value; (*this)(i, i) = value;
} }
/** @copydoc RectangularMatrix::RectangularMatrix(T, U...) */ /** @copydoc RectangularMatrix::RectangularMatrix */
#ifndef DOXYGEN_GENERATING_OUTPUT #ifndef DOXYGEN_GENERATING_OUTPUT
template<class ...U> inline constexpr Matrix(T first, U... next): RectangularMatrix<size, size, T>(first, next...) {} template<class ...U> inline constexpr Matrix(T first, U... next): RectangularMatrix<size, size, T>(first, next...) {}
#else #else
@ -115,15 +115,12 @@ template<size_t s, class T> class Matrix: public RectangularMatrix<s, s, T> {
/** /**
* @brief Determinant * @brief Determinant
* *
* Computed recursively using Laplace's formula: * Computed recursively using Laplace's formula: @f[
* @f[ * \det(A) = \sum_{j=1}^n (-1)^{i+j} a_{i,j} \det(A^{i,j})
* \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
* @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 * ij(). The formula is expanded down to 2x2 matrix, where the
* determinant is computed directly: * determinant is computed directly: @f[
* @f[ * \det(A) = a_{0, 0} a_{1, 1} - a_{1, 0} a_{0, 1}
* \det(A) = a_{0, 0} a_{1, 1} - a_{1, 0} a_{0, 1}
* @f] * @f]
*/ */
inline T determinant() const { return Implementation::MatrixDeterminant<size, T>()(*this); } inline T determinant() const { return Implementation::MatrixDeterminant<size, T>()(*this); }
@ -131,9 +128,8 @@ template<size_t s, class T> class Matrix: public RectangularMatrix<s, s, T> {
/** /**
* @brief Inverted matrix * @brief Inverted matrix
* *
* Computed using Cramer's rule: * Computed using Cramer's rule: @f[
* @f[ * A^{-1} = \frac{1}{\det(A)} Adj(A)
* A^{-1} = \frac{1}{\det(A)} Adj(A)
* @f] * @f]
*/ */
Matrix<size, T> inverted() const { Matrix<size, T> inverted() const {

2
src/Math/Matrix3.h

@ -86,7 +86,7 @@ template<class T> class Matrix3: public Matrix<3, T> {
T(0), T(0), value T(0), T(0), value
) {} ) {}
/** @copydoc Matrix::Matrix(T, U...) */ /** @copydoc Matrix::Matrix */
#ifndef DOXYGEN_GENERATING_OUTPUT #ifndef DOXYGEN_GENERATING_OUTPUT
template<class ...U> inline constexpr Matrix3(T first, U... next): Matrix<3, T>(first, next...) {} template<class ...U> inline constexpr Matrix3(T first, U... next): Matrix<3, T>(first, next...) {}
#else #else

2
src/Math/Matrix4.h

@ -116,7 +116,7 @@ template<class T> class Matrix4: public Matrix<4, T> {
T(0), T(0), T(0), value T(0), T(0), T(0), value
) {} ) {}
/** @copydoc Matrix::Matrix(T, U...) */ /** @copydoc Matrix::Matrix */
#ifndef DOXYGEN_GENERATING_OUTPUT #ifndef DOXYGEN_GENERATING_OUTPUT
template<class ...U> inline constexpr Matrix4(T first, U... next): Matrix<4, T>(first, next...) {} template<class ...U> inline constexpr Matrix4(T first, U... next): Matrix<4, T>(first, next...) {}
#else #else

1
src/Math/Vector4.h

@ -34,7 +34,6 @@ template<class T> class Vector4: public Vector<4, T> {
public: public:
/** /**
* @copydoc Vector::Vector * @copydoc Vector::Vector
*
* W component is set to one. * W component is set to one.
*/ */
inline constexpr Vector4(): Vector<4, T>(T(0), T(0), T(0), T(1)) {} inline constexpr Vector4(): Vector<4, T>(T(0), T(0), T(0), T(1)) {}

Loading…
Cancel
Save