From 280ce139d6cba5f177baa126ab7f1b4a8d450c1a Mon Sep 17 00:00:00 2001 From: LaurentGom Date: Fri, 11 Jun 2010 21:52:51 +0000 Subject: [PATCH] Some minor corrections in API documentation and parameters names git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1525 4e206d99-4929-0410-ac5d-dfc041789085 --- doc/build/Doxygen.hpp | 2 +- include/SFML/Graphics/Drawable.hpp | 8 ++++---- include/SFML/Graphics/Image.hpp | 2 +- include/SFML/Graphics/Renderer.hpp | 2 ++ include/SFML/Graphics/Shader.hpp | 6 +++--- include/SFML/Graphics/Shape.hpp | 12 ++++++------ include/SFML/Network/Ftp.hpp | 4 +--- include/SFML/System/Resource.hpp | 8 ++++---- include/SFML/System/ResourcePtr.inl | 4 ++-- include/SFML/System/String.hpp | 2 +- include/SFML/System/Thread.hpp | 2 +- include/SFML/Window/WindowStyle.hpp | 8 ++++---- src/SFML/Audio/SoundBuffer.cpp | 6 +++--- src/SFML/Graphics/Image.cpp | 4 ++-- 14 files changed, 35 insertions(+), 35 deletions(-) diff --git a/doc/build/Doxygen.hpp b/doc/build/Doxygen.hpp index f83562017..032e03545 100644 --- a/doc/build/Doxygen.hpp +++ b/doc/build/Doxygen.hpp @@ -4,7 +4,7 @@ /// \section welcome Welcome /// Welcome to the official SFML documentation. Here you will find a detailed /// view of all the SFML classes, as well as source -/// files.
+/// files.
/// If you are looking for tutorials, you can visit the official website /// at www.sfml-dev.org. /// diff --git a/include/SFML/Graphics/Drawable.hpp b/include/SFML/Graphics/Drawable.hpp index d110780fb..7f38735ab 100644 --- a/include/SFML/Graphics/Drawable.hpp +++ b/include/SFML/Graphics/Drawable.hpp @@ -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) diff --git a/include/SFML/Graphics/Image.hpp b/include/SFML/Graphics/Image.hpp index 676c5ed5d..c63e1d1c2 100644 --- a/include/SFML/Graphics/Image.hpp +++ b/include/SFML/Graphics/Image.hpp @@ -373,7 +373,7 @@ public : /// \return Reference to self /// //////////////////////////////////////////////////////////// - Image& operator =(const Image& other); + Image& operator =(const Image& right); private : diff --git a/include/SFML/Graphics/Renderer.hpp b/include/SFML/Graphics/Renderer.hpp index d660ad638..afd335ee6 100644 --- a/include/SFML/Graphics/Renderer.hpp +++ b/include/SFML/Graphics/Renderer.hpp @@ -249,6 +249,8 @@ public : /// renderer.End(); /// \endcode /// + /// \param type Type of the primitives that are going to be rendered + /// /// \see End /// //////////////////////////////////////////////////////////// diff --git a/include/SFML/Graphics/Shader.hpp b/include/SFML/Graphics/Shader.hpp index 6cd3c8418..67ba03750 100644 --- a/include/SFML/Graphics/Shader.hpp +++ b/include/SFML/Graphics/Shader.hpp @@ -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 diff --git a/include/SFML/Graphics/Shape.hpp b/include/SFML/Graphics/Shape.hpp index aa30ae396..d5c8706ca 100644 --- a/include/SFML/Graphics/Shape.hpp +++ b/include/SFML/Graphics/Shape.hpp @@ -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 diff --git a/include/SFML/Network/Ftp.hpp b/include/SFML/Network/Ftp.hpp index c806317ae..047f5db58 100644 --- a/include/SFML/Network/Ftp.hpp +++ b/include/SFML/Network/Ftp.hpp @@ -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 /// diff --git a/include/SFML/System/Resource.hpp b/include/SFML/System/Resource.hpp index cd1fbf621..c94180eaa 100644 --- a/include/SFML/System/Resource.hpp +++ b/include/SFML/System/Resource.hpp @@ -77,12 +77,12 @@ protected : //////////////////////////////////////////////////////////// /// \brief Assignment operator /// - /// \param other Instance to copy + /// \param right Instance to assign /// /// \return Reference to self /// //////////////////////////////////////////////////////////// - Resource& operator =(const Resource& other); + Resource& operator =(const Resource& 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& operator =(const ResourcePtr& other); + ResourcePtr& operator =(const ResourcePtr& right); //////////////////////////////////////////////////////////// /// \brief Assignment operator for a raw pointer parameter diff --git a/include/SFML/System/ResourcePtr.inl b/include/SFML/System/ResourcePtr.inl index b94e5e8f2..3aa5f3634 100644 --- a/include/SFML/System/ResourcePtr.inl +++ b/include/SFML/System/ResourcePtr.inl @@ -63,12 +63,12 @@ ResourcePtr::~ResourcePtr() //////////////////////////////////////////////////////////// template -ResourcePtr& ResourcePtr::operator =(const ResourcePtr& other) +ResourcePtr& ResourcePtr::operator =(const ResourcePtr& right) { if (myResource) myResource->Disconnect(*this); - myResource = other.myResource; + myResource = right.myResource; if (myResource) myResource->Connect(*this); diff --git a/include/SFML/System/String.hpp b/include/SFML/System/String.hpp index 729aa2d68..fcd9a6178 100644 --- a/include/SFML/System/String.hpp +++ b/include/SFML/System/String.hpp @@ -189,7 +189,7 @@ public : //////////////////////////////////////////////////////////// /// \brief Copy constructor /// - /// \param other Instance to copy + /// \param copy Instance to copy /// //////////////////////////////////////////////////////////// String(const String& copy); diff --git a/include/SFML/System/Thread.hpp b/include/SFML/System/Thread.hpp index 2e2248264..ab3990664 100644 --- a/include/SFML/System/Thread.hpp +++ b/include/SFML/System/Thread.hpp @@ -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 diff --git a/include/SFML/Window/WindowStyle.hpp b/include/SFML/Window/WindowStyle.hpp index d65fcf23e..342052135 100644 --- a/include/SFML/Window/WindowStyle.hpp +++ b/include/SFML/Window/WindowStyle.hpp @@ -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) diff --git a/src/SFML/Audio/SoundBuffer.cpp b/src/SFML/Audio/SoundBuffer.cpp index 48366f9df..792a8018b 100644 --- a/src/SFML/Audio/SoundBuffer.cpp +++ b/src/SFML/Audio/SoundBuffer.cpp @@ -49,7 +49,7 @@ myDuration(0.f) //////////////////////////////////////////////////////////// -SoundBuffer::SoundBuffer(const SoundBuffer& copy) : +SoundBuffer::SoundBuffer(const SoundBuffer& copy) : Resource(), myBuffer (0), mySamples (copy.mySamples), @@ -226,9 +226,9 @@ float SoundBuffer::GetDuration() const //////////////////////////////////////////////////////////// -SoundBuffer& SoundBuffer::operator =(const SoundBuffer& other) +SoundBuffer& SoundBuffer::operator =(const SoundBuffer& right) { - SoundBuffer temp(other); + SoundBuffer temp(right); std::swap(mySamples, temp.mySamples); std::swap(myBuffer, temp.myBuffer); diff --git a/src/SFML/Graphics/Image.cpp b/src/SFML/Graphics/Image.cpp index 602e686e7..229fa9c36 100644 --- a/src/SFML/Graphics/Image.cpp +++ b/src/SFML/Graphics/Image.cpp @@ -553,9 +553,9 @@ unsigned int Image::GetMaximumSize() //////////////////////////////////////////////////////////// -Image& Image::operator =(const Image& other) +Image& Image::operator =(const Image& right) { - Image temp(other); + Image temp(right); std::swap(myWidth, temp.myWidth); std::swap(myHeight, temp.myHeight);