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

Some minor corrections in API documentation and parameters names

Browse source 
git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1525 4e206d99-4929-0410-ac5d-dfc041789085
This commit is contained in:
LaurentGom 2010-06-11 21:52:51 +00:00
parent 1ee9965059
commit 280ce139d6
14 changed files with 35 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

8
include/SFML/Graphics/Drawable.hpp
View file

@ -38,12 +38,12 @@ namespace sf
class Renderer;
class RenderTarget;
////////////////////////////////////////////////////////////
/// \brief Available blending modes for drawable objects
///
////////////////////////////////////////////////////////////
namespace Blend
{
////////////////////////////////////////////////////////////
/// \brief Available blending modes for drawable objects
///
////////////////////////////////////////////////////////////
enum Mode
{
Alpha, ///< Pixel = Src * Src.a + Dest * (1 - Src.a)

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

@ -373,7 +373,7 @@ public :
/// \return Reference to self
///
////////////////////////////////////////////////////////////
Image& operator =(const Image& other);
Image& operator =(const Image& right);
private :

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

@ -249,6 +249,8 @@ public :
/// renderer.End();
/// \endcode
///
/// \param type Type of the primitives that are going to be rendered
///
/// \see End
///
////////////////////////////////////////////////////////////

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

@ -144,7 +144,7 @@ public :
/// \see SetTexture
///
////////////////////////////////////////////////////////////
void SetParameter(const std::string& Name, float x, float y);
void SetParameter(const std::string& name, float x, float y);
////////////////////////////////////////////////////////////
/// \brief Change a 3-components vector parameter of the shader
@ -166,7 +166,7 @@ public :
/// \see SetTexture
///
////////////////////////////////////////////////////////////
void SetParameter(const std::string& Name, float x, float y, float z);
void SetParameter(const std::string& name, float x, float y, float z);
////////////////////////////////////////////////////////////
/// \brief Change a 4-components vector parameter of the shader
@ -189,7 +189,7 @@ public :
/// \see SetTexture
///
////////////////////////////////////////////////////////////
void SetParameter(const std::string& Name, float x, float y, float z, float w);
void SetParameter(const std::string& name, float x, float y, float z, float w);
////////////////////////////////////////////////////////////
/// \brief Change a 2-components vector parameter of the shader

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

@ -79,7 +79,7 @@ public :
////////////////////////////////////////////////////////////
/// \brief Get the number of points composing the shape
///
/// \param Total number of points
/// \return Total number of points
///
////////////////////////////////////////////////////////////
unsigned int GetPointsCount() const;
@ -202,7 +202,7 @@ public :
/// \a index, if it is out of bounds (ie. in the range
/// [0, GetPointscount() - 1]) the behaviour is undefined.
///
/// \param Index index of the point
/// \param index Index of the point
///
/// \return Color of the index-th point
///
@ -246,10 +246,10 @@ public :
/// sf::Shape line = sf::Shape::Line(0, 0, 10, 20, 2.5f, sf::Color::Green);
/// \endcode
///
/// \param x0 X coordinate of the start point
/// \param y0 Y coordinate of the start point
/// \param x1 X coordinate of the end point
/// \param y1 Y coordinate of the end point
/// \param p1x X coordinate of the start point
/// \param p1y Y coordinate of the start point
/// \param p2x X coordinate of the end point
/// \param p2y Y coordinate of the end point
/// \param thickness Thickness of the line
/// \param color Color of the shape's points
/// \param outline Outline width

4
include/SFML/Network/Ftp.hpp
View file

@ -401,7 +401,7 @@ public :
/// Use this function with caution, the directory will
/// be removed permanently!
///
/// \param Name Name of the directory to remove
/// \param name Name of the directory to remove
///
/// \return Server response to the request
///
@ -457,7 +457,6 @@ public :
/// \param remoteFile Filename of the distant file to download
/// \param localPath Where to put to file on the local computer
/// \param mode Transfer mode
/// \param handler Object that will be notified of the download progress
///
/// \return Server response to the request
///
@ -480,7 +479,6 @@ public :
/// \param localFile Path of the local file to upload
/// \param remotePath Where to put to file on the server
/// \param mode Transfer mode
/// \param handler Object that will be notified of the upload progress
///
/// \return Server response to the request
///

8
include/SFML/System/Resource.hpp
View file

@ -77,12 +77,12 @@ protected :
////////////////////////////////////////////////////////////
/// \brief Assignment operator
///
/// \param other Instance to copy
/// \param right Instance to assign
///
/// \return Reference to self
///
////////////////////////////////////////////////////////////
Resource<T>& operator =(const Resource<T>& other);
Resource<T>& operator =(const Resource<T>& right);
private :
@ -162,12 +162,12 @@ public :
////////////////////////////////////////////////////////////
/// \brief Assignment operator for a ResourcePtr parameter
///
/// \param other ResourcePtr to assign
/// \param right Instance to assign
///
/// \return Reference to self
///
////////////////////////////////////////////////////////////
ResourcePtr<T>& operator =(const ResourcePtr<T>& other);
ResourcePtr<T>& operator =(const ResourcePtr<T>& right);
////////////////////////////////////////////////////////////
/// \brief Assignment operator for a raw pointer parameter

4
include/SFML/System/ResourcePtr.inl
View file

@ -63,12 +63,12 @@ ResourcePtr<T>::~ResourcePtr()
////////////////////////////////////////////////////////////
template <typename T>
ResourcePtr<T>& ResourcePtr<T>::operator =(const ResourcePtr<T>& other)
ResourcePtr<T>& ResourcePtr<T>::operator =(const ResourcePtr<T>& right)
{
if (myResource)
myResource->Disconnect(*this);
myResource = other.myResource;
myResource = right.myResource;
if (myResource)
myResource->Connect(*this);

2
include/SFML/System/String.hpp
View file

@ -189,7 +189,7 @@ public :
////////////////////////////////////////////////////////////
/// \brief Copy constructor
///
/// \param other Instance to copy
/// \param copy Instance to copy
///
////////////////////////////////////////////////////////////
String(const String& copy);

2
include/SFML/System/Thread.hpp
View file

@ -48,7 +48,7 @@ class SFML_API Thread : NonCopyable
{
public :
typedef void (*FuncType)(void*); // Type of functions that can be used as thread entry points
typedef void (*FuncType)(void*); ///< Type of functions that can be used as thread entry points
////////////////////////////////////////////////////////////
/// \brief Construct the thread from a function pointer

8
include/SFML/Window/WindowStyle.hpp
View file

@ -28,12 +28,12 @@
namespace sf
{
////////////////////////////////////////////////////////////
/// \brief Enumeration of the window styles
///
////////////////////////////////////////////////////////////
namespace Style
{
////////////////////////////////////////////////////////////
/// \brief Enumeration of the window styles
///
////////////////////////////////////////////////////////////
enum
{
None = 0, ///< No border / title bar (this flag and all others are mutually exclusive)