Browse Source

Documentation fixes.

pull/278/head
Vladimír Vondruš 13 years ago
parent
commit
330794d710
  1. 2
      src/Array.h
  2. 24
      src/Math/Geometry/Distance.h
  3. 2
      src/Math/RectangularMatrix.h

2
src/Array.h

@ -24,7 +24,7 @@
DEALINGS IN THE SOFTWARE. DEALINGS IN THE SOFTWARE.
*/ */
/** @file /** @file /Array.h
* @brief Class Magnum::Array, Magnum::Array1D, Magnum::Array2D, Magnum::Array3D * @brief Class Magnum::Array, Magnum::Array1D, Magnum::Array2D, Magnum::Array3D
*/ */

24
src/Math/Geometry/Distance.h

@ -160,7 +160,13 @@ class Distance {
template<class T> static T lineSegmentPointSquared(const Vector3<T>& a, const Vector3<T>& b, const Vector3<T>& point); template<class T> static T lineSegmentPointSquared(const Vector3<T>& a, const Vector3<T>& b, const Vector3<T>& point);
}; };
template<class T> T Distance::lineSegmentPoint(const Vector2<T>& a, const Vector2<T>& b, const Vector2<T>& point) { /** @todoc Remove workaround when Doxygen is sane */
#ifdef DOXYGEN_GENERATING_OUTPUT
template<class T> static
#else
template<class T>
#endif
T Distance::lineSegmentPoint(const Vector2<T>& a, const Vector2<T>& b, const Vector2<T>& point) {
const Vector2<T> pointMinusA = point - a; const Vector2<T> pointMinusA = point - a;
const Vector2<T> pointMinusB = point - b; const Vector2<T> pointMinusB = point - b;
const Vector2<T> bMinusA = b - a; const Vector2<T> bMinusA = b - a;
@ -180,7 +186,13 @@ template<class T> T Distance::lineSegmentPoint(const Vector2<T>& a, const Vector
return std::abs(Vector2<T>::cross(bMinusA, -pointMinusA))/std::sqrt(bDistanceA); return std::abs(Vector2<T>::cross(bMinusA, -pointMinusA))/std::sqrt(bDistanceA);
} }
template<class T> T Distance::lineSegmentPointSquared(const Vector2<T>& a, const Vector2<T>& b, const Vector2<T>& point) { /** @todoc Remove workaround when Doxygen is sane */
#ifdef DOXYGEN_GENERATING_OUTPUT
template<class T> static
#else
template<class T>
#endif
T Distance::lineSegmentPointSquared(const Vector2<T>& a, const Vector2<T>& b, const Vector2<T>& point) {
const Vector2<T> pointMinusA = point - a; const Vector2<T> pointMinusA = point - a;
const Vector2<T> pointMinusB = point - b; const Vector2<T> pointMinusB = point - b;
const Vector2<T> bMinusA = b - a; const Vector2<T> bMinusA = b - a;
@ -200,7 +212,13 @@ template<class T> T Distance::lineSegmentPointSquared(const Vector2<T>& a, const
return Math::pow<2>(Vector2<T>::cross(bMinusA, -pointMinusA))/bDistanceA; return Math::pow<2>(Vector2<T>::cross(bMinusA, -pointMinusA))/bDistanceA;
} }
template<class T> T Distance::lineSegmentPointSquared(const Vector3<T>& a, const Vector3<T>& b, const Vector3<T>& point) { /** @todoc Remove workaround when Doxygen is sane */
#ifdef DOXYGEN_GENERATING_OUTPUT
template<class T> static
#else
template<class T>
#endif
T Distance::lineSegmentPointSquared(const Vector3<T>& a, const Vector3<T>& b, const Vector3<T>& point) {
const Vector3<T> pointMinusA = point - a; const Vector3<T> pointMinusA = point - a;
const Vector3<T> pointMinusB = point - b; const Vector3<T> pointMinusB = point - b;
const T pointDistanceA = pointMinusA.dot(); const T pointDistanceA = pointMinusA.dot();

2
src/Math/RectangularMatrix.h

@ -180,7 +180,7 @@ template<std::size_t cols, std::size_t rows, class T> class RectangularMatrix {
* @see row(), data() * @see row(), data()
*/ */
Vector<rows, T>& operator[](std::size_t col) { return _data[col]; } Vector<rows, T>& operator[](std::size_t col) { return _data[col]; }
constexpr const Vector<rows, T>& operator[](std::size_t col) const { return _data[col]; } /** @overload */ constexpr const Vector<rows, T>& operator[](std::size_t col) const { return _data[col]; } /**< @overload */
/** /**
* @brief %Matrix row * @brief %Matrix row

Loading…
Cancel
Save