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

Fixed Documentation of this branch

parent 74c6a1cd
...@@ -309,7 +309,15 @@ distPointTriangleSquared( const Vec& _p, ...@@ -309,7 +309,15 @@ distPointTriangleSquared( const Vec& _p,
Vec& _nearestPoint ); Vec& _nearestPoint );
/** \brief squared distance from point _p to triangle (_v0, _v1, _v2) /** \brief squared distance from point _p to triangle (_v0, _v1, _v2)
* In the stable version the distance to the longest edge is returned if the triangle is degenerate. *
* In the stable version the distance to the longest edge
* is returned if the triangle is degenerate.
*
* @param _p point to test against triangle
* @param _v0 First point of trianlge
* @param _v1 Second point of trianlge
* @param _v2 Third point of trianlge
* @return Computed distance
*/ */
template <class Vec> template <class Vec>
typename Vec::value_type typename Vec::value_type
...@@ -330,7 +338,14 @@ distPointTriangle( const Vec& _p, ...@@ -330,7 +338,14 @@ distPointTriangle( const Vec& _p,
{ return sqrt(distPointTriangleSquared(_p, _v0, _v1, _v2, _nearestPoint)); } { return sqrt(distPointTriangleSquared(_p, _v0, _v1, _v2, _nearestPoint)); }
/** \brief distance from point _p to triangle (_v0, _v1, _v2) /** \brief distance from point _p to triangle (_v0, _v1, _v2)
* In the stable version the distance to the longest edge is returned if the triangle is degenerate. *
* In the stable version the distance to the longest edge
* is returned if the triangle is degenerate.
*
* @param _v0 First point of trianlge
* @param _v1 Second point of trianlge
* @param _v2 Third point of trianlge
* @return Computed distance
*/ */
template <class Vec> template <class Vec>
typename Vec::value_type typename Vec::value_type
......
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