Skip to content

Commit

Permalink
Minor: Fixes some documentation typos and formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
kennyweiss committed Mar 25, 2024
1 parent e2797cd commit c992d4c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
13 changes: 5 additions & 8 deletions src/axom/primal/operators/winding_number.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ namespace axom
namespace primal
{
//@{
//! @name Winding number operations between 2D points and primatives
//! @name Winding number operations between 2D points and primitives

/*
* \brief Compute the winding number with respect to a 2D line segment
Expand Down Expand Up @@ -201,8 +201,7 @@ int winding_number(const Point<T, 2>& R,
*
* \param [in] query The query point to test
* \param [in] c The Bezier curve object
* \param [in] edge_tol The physical distance level at which objects are
* considered indistinguishable
* \param [in] edge_tol The physical distance level at which objects are considered indistinguishable
* \param [in] EPS Miscellaneous numerical tolerance level for nonphysical distances
*
* Computes the winding number using a recursive, bisection algorithm,
Expand All @@ -224,8 +223,7 @@ double winding_number(const Point<T, 2>& q,
*
* \param [in] query The query point to test
* \param [in] cpoly The CurvedPolygon object
* \param [in] edge_tol The physical distance level at which objects are
* considered indistinguishable
* \param [in] edge_tol The physical distance level at which objects are considered indistinguishable
* \param [in] EPS Miscellaneous numerical tolerance level for nonphysical distances
*
* Computes the winding number by summing the winding number for each curve
Expand All @@ -251,16 +249,15 @@ double winding_number(const Point<T, 2>& q,
//@}

//@{
//! @name Winding number operations between 3D points and primatives
//! @name Winding number operations between 3D points and primitives

/*!
* \brief Computes the solid angle winding number for a 3D triangle
*
* \param [in] query The query point to test
* \param [in] tri The 3D Triangle object
* \param [in] isOnFace An optional return parameter if the point is on the triangle
* \param [in] edge_tol The physical distance level at which objects are
* considered indistinguishable
* \param [in] edge_tol The physical distance level at which objects are considered indistinguishable
* \param [in] EPS Miscellaneous numerical tolerance level for nonphysical distances
*
* Computes the winding number using the formula from
Expand Down
3 changes: 1 addition & 2 deletions src/axom/primal/tests/primal_winding_number.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ namespace primal = axom::primal;

TEST(primal_winding_number, simple_cases)
{
// Test points that are straightforwardly "inside" or "outside"
// the closed shape
// Test points that are straightforwardly "inside" or "outside" the closed shape
using Point2D = primal::Point<double, 2>;
using Triangle = primal::Triangle<double, 2>;
using Bezier = primal::BezierCurve<double, 2>;
Expand Down

0 comments on commit c992d4c

Please sign in to comment.