lauchmelder/SFML
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor corrections in API documentation

Browse source
This commit is contained in:
Marco Antognini 2012-08-23 12:34:51 +02:00
parent 757a785ed7
commit f970a6441f
13 changed files with 27 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/SFML/Graphics/CircleShape.hpp
View file

@ -96,7 +96,7 @@ public :
///
/// 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 .. getPointCount() - 1]
///
/// \return Index-th point of the shape
///

6
include/SFML/Graphics/ConvexShape.hpp
View file

@ -78,11 +78,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
/// 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, in range [0 .. GetPointCount() - 1]
/// \param index Index of the point to change, in range [0 .. getPointCount() - 1]
/// \param point New position of the point
///
/// \see getPoint
@ -95,7 +95,7 @@ public :
///
/// 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 .. getPointCount() - 1]
///
/// \return Position of the index-th point of the polygon
///

2
include/SFML/Graphics/RectangleShape.hpp
View file

@ -83,7 +83,7 @@ public :
///
/// 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 .. getPointCount() - 1]
///
/// \return Index-th point of the shape
///

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

@ -201,7 +201,7 @@ public :
///
/// 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 .. getPointCount() - 1]
///
/// \return Index-th point of the shape
///

10
include/SFML/Graphics/Transformable.hpp
View file

@ -397,18 +397,18 @@ private :
/// class MyEntity
/// {
/// public :
/// void SetPosition(const MyVector& v)
/// void setPosition(const MyVector& v)
/// {
/// myTransform.setPosition(v.x(), v.y());
/// m_transform.setPosition(v.x(), v.y());
/// }
///
/// void Draw(sf::RenderTarget& target) const
/// void draw(sf::RenderTarget& target) const
/// {
/// target.draw(..., myTransform.getTransform());
/// target.draw(..., m_transform.getTransform());
/// }
///
/// private :
/// sf::Transformable myTransform;
/// sf::Transformable m_transform;
/// };
/// \endcode
///

4
include/SFML/Graphics/VertexArray.hpp
View file

@ -75,7 +75,7 @@ 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]. The behaviour is undefined
/// [0, getVertexCount() - 1]. The behaviour is undefined
/// otherwise.
///
/// \param index Index of the vertex to get
@ -91,7 +91,7 @@ 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]. The behaviour is undefined
/// [0, getVertexCount() - 1]. The behaviour is undefined
/// otherwise.
///
/// \param index Index of the vertex to get