Updated documentation

This commit is contained in:
Pascal Serrarens 2024-01-02 12:03:02 +01:00
parent ed89b91826
commit 846e9c048f

View File

@ -37,7 +37,7 @@ public:
/// objects may be considered the same
/// @details When the difference in distance is exactly this
/// value, the objects can be the same.
/// @example with a value of 0.3, objects with coordinates position->distance
/// With a value of 0.3, objects with coordinates position->distance
/// = 1.2F and position->distance = 1.6 will be considered different, but
/// objects with coordinates position->distance = 1.2 and position->distance
/// = 1.0 can be the same.
@ -46,7 +46,7 @@ public:
/// which two objects may be considered the same
/// @details When the difference in angle is exactly this value, the objects
/// can be the same.
/// @example With a value of 5.0, object with coordinates position->angle = 30
/// With a value of 5.0, object with coordinates position->angle = 30
/// and position->angle = 36 will be considered different, but object with
/// coordinated position->angle = 30 and position->angle = 27 can be the same.
static constexpr float equalityAngle = 5.0F;