Edgaru089/SFML
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor improvements to the API documentation

Browse Source
This commit is contained in:
Laurent Gomila 2011-12-28 22:36:09 +01:00
parent aa633f6f12
commit 8de7fca241
5 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/SFML/Graphics/CircleShape.hpp
View File

@ -93,7 +93,9 @@ public :
////////////////////////////////////////////////////////////
/// \brief Get a point of the shape
///
/// \param index Index of the point to get
/// 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
///

11
include/SFML/Graphics/ConvexShape.hpp
View File

@ -53,6 +53,8 @@ public :
////////////////////////////////////////////////////////////
/// \brief Set the number of points of the polygon
///
/// \a count must be greater than 2 to define a valid shape.
///
/// \param count New number of points of the polygon
///
/// \see GetPointCount
@ -75,8 +77,11 @@ public :
///
/// 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.
///
/// \param index Index of the point to change
/// \param index Index of the point to change, in range [0 .. GetPointCount() - 1]
/// \param point New position of the point
///
/// \see GetPoint
@ -87,7 +92,9 @@ public :
////////////////////////////////////////////////////////////
/// \brief Get the position of a point
///
/// \param index Index of the point to get
/// 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 Position of the index-th point of the polygon
///

4
include/SFML/Graphics/RectangleShape.hpp
View File

@ -80,7 +80,9 @@ public :
////////////////////////////////////////////////////////////
/// \brief Get a point of the shape
///
/// \param index Index of the point to get
/// 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
///

2
include/SFML/Graphics/Shape.hpp
View File

@ -195,6 +195,8 @@ public :
////////////////////////////////////////////////////////////
/// \brief Get a point of the shape
///
/// 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

6
include/SFML/Graphics/VertexArray.hpp
View File

@ -74,7 +74,8 @@ public :
/// \brief Get a read-write access to a vertex by its index
///
/// This function doesn't check \a index, it must be in range
/// [0, GetVertexCount() - 1].
/// [0, GetVertexCount() - 1]. The behaviour is undefined
/// otherwise.
///
/// \param index Index of the vertex to get
///
@ -89,7 +90,8 @@ public :
/// \brief Get a read-only access to a vertex by its index
///
/// This function doesn't check \a index, it must be in range
/// [0, GetVertexCount() - 1].
/// [0, GetVertexCount() - 1]. The behaviour is undefined
/// otherwise.
///
/// \param index Index of the vertex to get
///