update scalar value

Signed-off-by: Arjo Chakravarty <[email protected]>
gazebosim · Sep 21, 2021 · b4f9ddc · b4f9ddc
1 parent 4c0bd02
commit b4f9ddc
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/include/ignition/math/detail/Box.hh b/include/ignition/math/detail/Box.hh
@@ -126,8 +126,9 @@ T Box<T>::Volume() const
 /// compute the list of triangles which form this polygon.
 /// \param[in] _plane The plane in which the vertices exist.
 /// \param[in] _vertices The vertices of the polygon.
-/// \return A vector of triangles and their centroids, or an empty vector
-/// if _vertices in the _plane are less than 3.
+/// \return A vector of triangles and their sign, or an empty vector
+/// if _vertices in the _plane are less than 3. The sign will be +1 if the
+/// triangle is outward facing, -1 otherwise.
 template <typename T>
 std::vector<std::pair<Triangle3<T>, T>> TrianglesInPlane(
  const Plane<T> &_plane, IntersectionPoints<T> &_vertices)