From e9243b7ef69083cce2fcb0651e45e42c1ea7adae Mon Sep 17 00:00:00 2001
From: Jan Haller <bromeon@gmail.com>
Date: Sat, 19 Apr 2014 11:19:16 +0200
Subject: [PATCH] Improved documentation for sf::Shape and derived classes

---
 include/SFML/Graphics/CircleShape.hpp    | 11 +++++++----
 include/SFML/Graphics/ConvexShape.hpp    |  3 +++
 include/SFML/Graphics/RectangleShape.hpp | 12 ++++++++----
 include/SFML/Graphics/Shape.hpp          |  5 ++++-
 4 files changed, 22 insertions(+), 9 deletions(-)

diff --git a/include/SFML/Graphics/CircleShape.hpp b/include/SFML/Graphics/CircleShape.hpp
index 75d4a8de..7dd6b7e9 100644
--- a/include/SFML/Graphics/CircleShape.hpp
+++ b/include/SFML/Graphics/CircleShape.hpp
@@ -82,9 +82,9 @@ public :
     void setPointCount(unsigned int count);
 
     ////////////////////////////////////////////////////////////
-    /// \brief Get the number of points of the shape
+    /// \brief Get the number of points of the circle
     ///
-    /// \return Number of points of the shape
+    /// \return Number of points of the circle
     ///
     /// \see setPointCount
     ///
@@ -92,13 +92,16 @@ public :
     virtual unsigned int getPointCount() const;
 
     ////////////////////////////////////////////////////////////
-    /// \brief Get a point of the shape
+    /// \brief Get a point of the circle
     ///
+    /// The returned point is in local coordinates, that is,
+    /// the shape's transforms (position, rotation, scale) are
+    /// not taken into account.
     /// The result is undefined if \a index is out of the valid range.
     ///
     /// \param index Index of the point to get, in range [0 .. getPointCount() - 1]
     ///
-    /// \return Index-th point of the shape
+    /// \return index-th point of the shape
     ///
     ////////////////////////////////////////////////////////////
     virtual Vector2f getPoint(unsigned int index) const;
diff --git a/include/SFML/Graphics/ConvexShape.hpp b/include/SFML/Graphics/ConvexShape.hpp
index 6ef5ac60..6ae756f6 100644
--- a/include/SFML/Graphics/ConvexShape.hpp
+++ b/include/SFML/Graphics/ConvexShape.hpp
@@ -93,6 +93,9 @@ public :
     ////////////////////////////////////////////////////////////
     /// \brief Get the position of a point
     ///
+    /// The returned point is in local coordinates, that is,
+    /// the shape's transforms (position, rotation, scale) are
+    /// not taken into account.
     /// The result is undefined if \a index is out of the valid range.
     ///
     /// \param index Index of the point to get, in range [0 .. getPointCount() - 1]
diff --git a/include/SFML/Graphics/RectangleShape.hpp b/include/SFML/Graphics/RectangleShape.hpp
index aad47473..08bfec7a 100644
--- a/include/SFML/Graphics/RectangleShape.hpp
+++ b/include/SFML/Graphics/RectangleShape.hpp
@@ -73,19 +73,23 @@ public :
     ////////////////////////////////////////////////////////////
     /// \brief Get the number of points defining the shape
     ///
-    /// \return Number of points of the shape
+    /// \return Number of points of the shape. For rectangle
+    ///         shapes, this number is always 4.
     ///
     ////////////////////////////////////////////////////////////
     virtual unsigned int getPointCount() const;
 
     ////////////////////////////////////////////////////////////
-    /// \brief Get a point of the shape
+    /// \brief Get a point of the rectangle
     ///
+    /// The returned point is in local coordinates, that is,
+    /// the shape's transforms (position, rotation, scale) are
+    /// not taken into account.
     /// The result is undefined if \a index is out of the valid range.
     ///
-    /// \param index Index of the point to get, in range [0 .. getPointCount() - 1]
+    /// \param index Index of the point to get, in range [0 .. 3]
     ///
-    /// \return Index-th point of the shape
+    /// \return index-th point of the shape
     ///
     ////////////////////////////////////////////////////////////
     virtual Vector2f getPoint(unsigned int index) const;
diff --git a/include/SFML/Graphics/Shape.hpp b/include/SFML/Graphics/Shape.hpp
index 75be1c2c..2405b18b 100644
--- a/include/SFML/Graphics/Shape.hpp
+++ b/include/SFML/Graphics/Shape.hpp
@@ -198,11 +198,14 @@ public :
     ////////////////////////////////////////////////////////////
     /// \brief Get a point of the shape
     ///
+    /// The returned point is in local coordinates, that is,
+    /// the shape's transforms (position, rotation, scale) are
+    /// not taken into account.
     /// The result is undefined if \a index is out of the valid range.
     ///
     /// \param index Index of the point to get, in range [0 .. getPointCount() - 1]
     ///
-    /// \return Index-th point of the shape
+    /// \return index-th point of the shape
     ///
     /// \see getPointCount
     ///