Clarify documentation on Rect::contains function bounds

This commit is contained in:
Mischa Aster Alff 2016-09-17 17:41:10 +02:00 committed by Lukas Dürrenberger
parent 550fb2b60a
commit 3d41e28e6a

View File

@ -95,6 +95,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Check if a point is inside the rectangle's area
///
/// This check is non-inclusive. If the point lies on the
/// edge of the rectangle, this function will return false.
///
/// \param x X coordinate of the point to test
/// \param y Y coordinate of the point to test
///
@ -108,6 +111,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Check if a point is inside the rectangle's area
///
/// This check is non-inclusive. If the point lies on the
/// edge of the rectangle, this function will return false.
///
/// \param point Point to test
///
/// \return True if the point is inside, false otherwise