Improved documentation for sf::Shape and derived classes

SFML · Apr 19, 2014 · e9243b7 · e9243b7
1 parent 19012c6
commit e9243b7
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 9 deletions.
diff --git a/include/SFML/Graphics/CircleShape.hpp b/include/SFML/Graphics/CircleShape.hpp
@@ -82,23 +82,26 @@ 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
     ///
     ////////////////////////////////////////////////////////////
     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
@@ -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
@@ -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
@@ -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
     ///