Minor changes to the documentation and some parameters names

git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1444 4e206d99-4929-0410-ac5d-dfc041789085
This commit is contained in:
LaurentGom 2010-03-08 17:50:16 +00:00
parent 4e93cc92fa
commit ef216acc5f
9 changed files with 42 additions and 41 deletions

View file

@ -83,7 +83,8 @@ private :
/// always be released when the current scope (most likely
/// a function) ends.
/// This is even more important when an exception or an early
/// return statement can interrupt the excution flow of the function.
/// return statement can interrupt the execution flow of the
/// function.
///
/// For maximum robustness, sf::Lock should always be used
/// to lock/unlock a mutex.
@ -129,7 +130,7 @@ private :
/// Having a mutex locked longer than required is a bad practice
/// which can lead to bad performances. Don't forget that when
/// a mutex is locked, other threads may be waiting doing nothing
/// until it ls released.
/// until it is released.
///
/// \see sf::Mutex
///

View file

@ -69,7 +69,7 @@ private :
////////////////////////////////////////////////////////////
/// \brief Disabled assignment operator
///
/// By making the copy constructor private, the compiler will
/// By making the assignment operator private, the compiler will
/// trigger an error if anyone outside tries to use it.
/// To prevent NonCopyable or friend classes from using it,
/// we also give no definition, so that the linker will

View file

@ -282,11 +282,11 @@ public :
////////////////////////////////////////////////////////////
/// \brief Change the position of the mouse cursor
///
/// \param left Left coordinate of the cursor, relative to the window
/// \param top Top coordinate of the cursor, relative to the window
/// \param x Left coordinate of the cursor, relative to the window
/// \param y Top coordinate of the cursor, relative to the window
///
////////////////////////////////////////////////////////////
void SetCursorPosition(unsigned int left, unsigned int top);
void SetCursorPosition(unsigned int x, unsigned int y);
////////////////////////////////////////////////////////////
/// \brief Change the position of the window on screen
@ -295,11 +295,11 @@ public :
/// (i.e. it will be ignored for windows created from
/// the handle of a child window/control).
///
/// \param left Left position
/// \param top Top position
/// \param x Left position
/// \param y Top position
///
////////////////////////////////////////////////////////////
void SetPosition(int left, int top);
void SetPosition(int x, int y);
////////////////////////////////////////////////////////////
/// \brief Change the size of the rendering region of the window