diff --git a/include/SFML/Graphics/ConvexShape.hpp b/include/SFML/Graphics/ConvexShape.hpp index 1914c8f8..6c8bc742 100644 --- a/include/SFML/Graphics/ConvexShape.hpp +++ b/include/SFML/Graphics/ConvexShape.hpp @@ -54,7 +54,8 @@ public: //////////////////////////////////////////////////////////// /// \brief Set the number of points of the polygon /// - /// \a count must be greater than 2 to define a valid shape. + /// For the shape to be rendered as expected, \a count must + /// be greater or equal to 3. /// /// \param count New number of points of the polygon /// @@ -76,11 +77,14 @@ public: //////////////////////////////////////////////////////////// /// \brief Set the position of a point /// - /// Don't forget that the polygon must remain convex, and - /// the points need to stay ordered! - /// setPointCount must be called first in order to set the total - /// number of points. The result is undefined if \a index is out - /// of the valid range. + /// Don't forget that the shape must be convex and the + /// order of points matters. Points should not overlap. + /// This applies to rendering; it is explicitly allowed + /// to temporarily have non-convex or degenerate shapes + /// when not drawn (e.g. during shape initialization). + /// + /// Point count must be specified beforehand. The behavior is + /// undefined if \a index is greater than or equal to getPointCount. /// /// \param index Index of the point to change, in range [0 .. getPointCount() - 1] /// \param point New position of the point