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

include/SFML/System/Lock.hpp

@@ -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
 ///

include/SFML/System/NonCopyable.hpp

@@ -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

include/SFML/Window/Window.hpp

@@ -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 x Left coordinate of the cursor, relative to the window
-    /// \param top  Top 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 x Left position
-    /// \param top  Top 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

src/SFML/Window/Linux/WindowImplX11.cpp

@@ -317,17 +317,17 @@ void WindowImplX11::ShowMouseCursor(bool show)
 
 
 ////////////////////////////////////////////////////////////
-void WindowImplX11::SetCursorPosition(unsigned int left, unsigned int top)
+void WindowImplX11::SetCursorPosition(unsigned int x, unsigned int y)
 {
-    XWarpPointer(myDisplay, None, myWindow, 0, 0, 0, 0, left, top);
+    XWarpPointer(myDisplay, None, myWindow, 0, 0, 0, 0, x, y);
     XFlush(myDisplay);
 }
 
 
 ////////////////////////////////////////////////////////////
-void WindowImplX11::SetPosition(int left, int top)
+void WindowImplX11::SetPosition(int x, int y)
 {
-    XMoveWindow(myDisplay, myWindow, left, top);
+    XMoveWindow(myDisplay, myWindow, x, y);
     XFlush(myDisplay);
 }
 

src/SFML/Window/Linux/WindowImplX11.hpp

@@ -110,20 +110,20 @@ private :
     ////////////////////////////////////////////////////////////
     /// \brief Change the position of the mouse cursor
     ///
-    /// \param left Left coordinate of the cursor, relative to the window
+    /// \param x Left coordinate of the cursor, relative to the window
-    /// \param top  Top coordinate of the cursor, relative to the window
+    /// \param y Top coordinate of the cursor, relative to the window
     ///
     ////////////////////////////////////////////////////////////
-    virtual void SetCursorPosition(unsigned int left, unsigned int top);
+    virtual void SetCursorPosition(unsigned int x, unsigned int y);
 
     ////////////////////////////////////////////////////////////
     /// \brief Change the position of the window on screen
     ///
-    /// \param left Left position
+    /// \param x Left position
-    /// \param top  Top position
+    /// \param y Top position
     ///
     ////////////////////////////////////////////////////////////
-    virtual void SetPosition(int left, int top);
+    virtual void SetPosition(int x, int y);
 
     ////////////////////////////////////////////////////////////
     /// \brief Change the size of the rendering region of the window

src/SFML/Window/Win32/WindowImplWin32.cpp

@@ -238,18 +238,18 @@ void WindowImplWin32::ShowMouseCursor(bool show)
 
 
 ////////////////////////////////////////////////////////////
-void WindowImplWin32::SetCursorPosition(unsigned int left, unsigned int top)
+void WindowImplWin32::SetCursorPosition(unsigned int x, unsigned int y)
 {
-    POINT position = {left, top};
+    POINT position = {x, y};
     ClientToScreen(myHandle, &position);
     SetCursorPos(position.x, position.y);
 }
 
 
 ////////////////////////////////////////////////////////////
-void WindowImplWin32::SetPosition(int left, int top)
+void WindowImplWin32::SetPosition(int x, int y)
 {
-    SetWindowPos(myHandle, NULL, left, top, 0, 0, SWP_NOSIZE | SWP_NOZORDER);
+    SetWindowPos(myHandle, NULL, x, y, 0, 0, SWP_NOSIZE | SWP_NOZORDER);
 }
 
 

src/SFML/Window/Win32/WindowImplWin32.hpp

@@ -99,20 +99,20 @@ private :
     ////////////////////////////////////////////////////////////
     /// \brief Change the position of the mouse cursor
     ///
-    /// \param left Left coordinate of the cursor, relative to the window
+    /// \param x Left coordinate of the cursor, relative to the window
-    /// \param top  Top coordinate of the cursor, relative to the window
+    /// \param y Top coordinate of the cursor, relative to the window
     ///
     ////////////////////////////////////////////////////////////
-    virtual void SetCursorPosition(unsigned int left, unsigned int top);
+    virtual void SetCursorPosition(unsigned int x, unsigned int y);
 
     ////////////////////////////////////////////////////////////
     /// \brief Change the position of the window on screen
     ///
-    /// \param left Left position
+    /// \param x Left position
-    /// \param top  Top position
+    /// \param y Top position
     ///
     ////////////////////////////////////////////////////////////
-    virtual void SetPosition(int left, int top);
+    virtual void SetPosition(int x, int y);
 
     ////////////////////////////////////////////////////////////
     /// \brief Change the size of the rendering region of the window

src/SFML/Window/Window.cpp

@@ -251,24 +251,24 @@ void Window::ShowMouseCursor(bool show)
 
 
 ////////////////////////////////////////////////////////////
-void Window::SetCursorPosition(unsigned int left, unsigned int top)
+void Window::SetCursorPosition(unsigned int x, unsigned int y)
 {
     if (myWindow)
     {
         // Keep coordinates for later checking (to reject the generated MouseMoved event)
-        mySetCursorPosX = left;
+        mySetCursorPosX = x;
-        mySetCursorPosY = top;
+        mySetCursorPosY = y;
 
-        myWindow->SetCursorPosition(left, top);
+        myWindow->SetCursorPosition(x, y);
     }
 }
 
 
 ////////////////////////////////////////////////////////////
-void Window::SetPosition(int left, int top)
+void Window::SetPosition(int x, int y)
 {
     if (myWindow)
-        myWindow->SetPosition(left, top);
+        myWindow->SetPosition(x, y);
 }
 
 

src/SFML/Window/WindowImpl.hpp

@@ -143,20 +143,20 @@ public :
     ////////////////////////////////////////////////////////////
     /// \brief Change the position of the mouse cursor
     ///
-    /// \param left Left coordinate of the cursor, relative to the window
+    /// \param x Left coordinate of the cursor, relative to the window
-    /// \param top  Top coordinate of the cursor, relative to the window
+    /// \param y Top coordinate of the cursor, relative to the window
     ///
     ////////////////////////////////////////////////////////////
-    virtual void SetCursorPosition(unsigned int left, unsigned int top) = 0;
+    virtual void SetCursorPosition(unsigned int x, unsigned int y) = 0;
 
     ////////////////////////////////////////////////////////////
     /// \brief Change the position of the window on screen
     ///
-    /// \param left Left position
+    /// \param x Left position
-    /// \param top  Top position
+    /// \param y Top position
     ///
     ////////////////////////////////////////////////////////////
-    virtual void SetPosition(int left, int top) = 0;
+    virtual void SetPosition(int x, int y) = 0;
 
     ////////////////////////////////////////////////////////////
     /// \brief Change the size of the rendering region of the window