Commit efe49f19 authored by Jan Möbius's avatar Jan Möbius
Browse files

Added some docs

parent bdddef69
...@@ -580,6 +580,9 @@ int isObtuse(const VectorT& _p0, ...@@ -580,6 +580,9 @@ int isObtuse(const VectorT& _p0,
/** \brief return squared area of triangle (_v0, _v1, _v2) /** \brief return squared area of triangle (_v0, _v1, _v2)
* *
* @param _v0 First point of triangle
* @param _v1 Second point of triangle
* @param _v2 Third point of triangl
*/ */
template <class Vec> template <class Vec>
typename Vec::value_type typename Vec::value_type
...@@ -590,6 +593,9 @@ triangleAreaSquared( const Vec& _v0, ...@@ -590,6 +593,9 @@ triangleAreaSquared( const Vec& _v0,
/** \brief return area of triangle (_v0, _v1, _v2) /** \brief return area of triangle (_v0, _v1, _v2)
* *
* @param _v0 First point of triangle
* @param _v1 Second point of triangle
* @param _v2 Third point of triangl
*/ */
template <class Vec> template <class Vec>
typename Vec::value_type typename Vec::value_type
...@@ -603,6 +609,9 @@ triangleArea( const Vec& _v0, ...@@ -603,6 +609,9 @@ triangleArea( const Vec& _v0,
/** \brief return aspect ratio (length/height) of triangle /** \brief return aspect ratio (length/height) of triangle
* *
* @param _v0 First point of triangle
* @param _v1 Second point of triangle
* @param _v2 Third point of triangl
*/ */
template <typename Scalar, int N> template <typename Scalar, int N>
Scalar Scalar
...@@ -612,6 +621,9 @@ aspectRatio( const VectorT<Scalar, N>& _v0, ...@@ -612,6 +621,9 @@ aspectRatio( const VectorT<Scalar, N>& _v0,
/** \brief return roundness of triangle: 1=equilateral, 0=colinear /** \brief return roundness of triangle: 1=equilateral, 0=colinear
* *
* @param _v0 First point of triangle
* @param _v1 Second point of triangle
* @param _v2 Third point of triangl
*/ */
template <typename Scalar, int N> template <typename Scalar, int N>
Scalar Scalar
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment