From f970a6441f935fad687e59982d6bfe363d02611a Mon Sep 17 00:00:00 2001 From: Marco Antognini Date: Thu, 23 Aug 2012 12:34:51 +0200 Subject: [PATCH] Minor corrections in API documentation --- include/SFML/Audio/Sound.hpp | 10 +++++----- include/SFML/Audio/SoundBufferRecorder.hpp | 4 ++-- include/SFML/Audio/SoundRecorder.hpp | 2 +- include/SFML/Graphics/CircleShape.hpp | 2 +- include/SFML/Graphics/ConvexShape.hpp | 6 +++--- include/SFML/Graphics/RectangleShape.hpp | 2 +- include/SFML/Graphics/Shape.hpp | 2 +- include/SFML/Graphics/Transformable.hpp | 10 +++++----- include/SFML/Graphics/VertexArray.hpp | 4 ++-- include/SFML/Network/Http.hpp | 4 ++-- include/SFML/Network/TcpSocket.hpp | 2 +- include/SFML/System/Mutex.hpp | 4 ++-- include/SFML/Window/VideoMode.hpp | 2 +- 13 files changed, 27 insertions(+), 27 deletions(-) diff --git a/include/SFML/Audio/Sound.hpp b/include/SFML/Audio/Sound.hpp index 3d53fe6c4..547b32f7a 100644 --- a/include/SFML/Audio/Sound.hpp +++ b/include/SFML/Audio/Sound.hpp @@ -83,7 +83,7 @@ public : /// This function uses its own thread so that it doesn't block /// the rest of the program while the sound is played. /// - /// \see Pause, Stop + /// \see pause, stop /// //////////////////////////////////////////////////////////// void play(); @@ -94,19 +94,19 @@ public : /// This function pauses the sound if it was playing, /// otherwise (sound already paused or stopped) it has no effect. /// - /// \see Play, Stop + /// \see play, stop /// //////////////////////////////////////////////////////////// void pause(); //////////////////////////////////////////////////////////// - /// \brief Stop playing the sound + /// \brief stop playing the sound /// /// This function stops the sound if it was playing or paused, /// and does nothing if it was already stopped. /// It also resets the playing position (unlike pause()). /// - /// \see Play, Pause + /// \see play, pause /// //////////////////////////////////////////////////////////// void stop(); @@ -120,7 +120,7 @@ public : /// /// \param buffer Sound buffer to attach to the sound /// - /// \see GetBuffer + /// \see getBuffer /// //////////////////////////////////////////////////////////// void setBuffer(const SoundBuffer& buffer); diff --git a/include/SFML/Audio/SoundBufferRecorder.hpp b/include/SFML/Audio/SoundBufferRecorder.hpp index eb7b7cb04..7e411fd47 100644 --- a/include/SFML/Audio/SoundBufferRecorder.hpp +++ b/include/SFML/Audio/SoundBufferRecorder.hpp @@ -117,10 +117,10 @@ private : /// /// Usage example: /// \code -/// if (SoundBufferRecorder::isAvailable()) +/// if (sf::SoundBufferRecorder::isAvailable()) /// { /// // Record some audio data -/// SoundBufferRecorder recorder; +/// sf::SoundBufferRecorder recorder; /// recorder.start(); /// ... /// recorder.stop(); diff --git a/include/SFML/Audio/SoundRecorder.hpp b/include/SFML/Audio/SoundRecorder.hpp index eb81b04c2..3287ed3da 100644 --- a/include/SFML/Audio/SoundRecorder.hpp +++ b/include/SFML/Audio/SoundRecorder.hpp @@ -215,7 +215,7 @@ private : /// /// The audio capture feature may not be supported or activated /// on every platform, thus it is recommended to check its -/// availability with the IsAvailable() function. If it returns +/// availability with the isAvailable() function. If it returns /// false, then any attempt to use an audio recorder will fail. /// /// It is important to note that the audio capture happens in a diff --git a/include/SFML/Graphics/CircleShape.hpp b/include/SFML/Graphics/CircleShape.hpp index 2f3a2b63a..9849f5090 100644 --- a/include/SFML/Graphics/CircleShape.hpp +++ b/include/SFML/Graphics/CircleShape.hpp @@ -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 /// diff --git a/include/SFML/Graphics/ConvexShape.hpp b/include/SFML/Graphics/ConvexShape.hpp index 43c335706..bed94dca7 100644 --- a/include/SFML/Graphics/ConvexShape.hpp +++ b/include/SFML/Graphics/ConvexShape.hpp @@ -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 /// diff --git a/include/SFML/Graphics/RectangleShape.hpp b/include/SFML/Graphics/RectangleShape.hpp index eb7dab8cf..3a4386dcf 100644 --- a/include/SFML/Graphics/RectangleShape.hpp +++ b/include/SFML/Graphics/RectangleShape.hpp @@ -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 /// diff --git a/include/SFML/Graphics/Shape.hpp b/include/SFML/Graphics/Shape.hpp index fad8b8b79..f0c9cbc40 100644 --- a/include/SFML/Graphics/Shape.hpp +++ b/include/SFML/Graphics/Shape.hpp @@ -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 /// diff --git a/include/SFML/Graphics/Transformable.hpp b/include/SFML/Graphics/Transformable.hpp index d6664c5e8..47d165bd5 100644 --- a/include/SFML/Graphics/Transformable.hpp +++ b/include/SFML/Graphics/Transformable.hpp @@ -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 /// diff --git a/include/SFML/Graphics/VertexArray.hpp b/include/SFML/Graphics/VertexArray.hpp index 1c2ebee42..cbfde9769 100644 --- a/include/SFML/Graphics/VertexArray.hpp +++ b/include/SFML/Graphics/VertexArray.hpp @@ -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 diff --git a/include/SFML/Network/Http.hpp b/include/SFML/Network/Http.hpp index 20315c4a2..6fedd9fa6 100644 --- a/include/SFML/Network/Http.hpp +++ b/include/SFML/Network/Http.hpp @@ -340,7 +340,7 @@ public : //////////////////////////////////////////////////////////// /// \brief Construct the HTTP client with the target host /// - /// This is equivalent to calling SetHost(host, port). + /// This is equivalent to calling setHost(host, port). /// The port has a default value of 0, which means that the /// HTTP client will use the right port according to the /// protocol used (80 for HTTP, 443 for HTTPS). You should @@ -373,7 +373,7 @@ public : //////////////////////////////////////////////////////////// /// \brief Send a HTTP request and return the server's response. /// - /// You must have a valid host before sending a request (see SetHost). + /// You must have a valid host before sending a request (see setHost). /// Any missing mandatory header field in the request will be added /// with an appropriate value. /// Warning: this function waits for the server's response and may diff --git a/include/SFML/Network/TcpSocket.hpp b/include/SFML/Network/TcpSocket.hpp index 9f2b829c6..7abe9d26c 100644 --- a/include/SFML/Network/TcpSocket.hpp +++ b/include/SFML/Network/TcpSocket.hpp @@ -227,7 +227,7 @@ private: /// /// When a socket is connected to a remote host, you can /// retrieve informations about this host with the -/// getRemoteAddress and GetRemotePort functions. You can +/// getRemoteAddress and getRemotePort functions. You can /// also get the local port to which the socket is bound /// (which is automatically chosen when the socket is connected), /// with the getLocalPort function. diff --git a/include/SFML/System/Mutex.hpp b/include/SFML/System/Mutex.hpp index 60235626c..783975c86 100644 --- a/include/SFML/System/Mutex.hpp +++ b/include/SFML/System/Mutex.hpp @@ -67,7 +67,7 @@ public : /// this call will block the execution until the mutex /// is released. /// - /// \see Unlock + /// \see unlock /// //////////////////////////////////////////////////////////// void lock(); @@ -75,7 +75,7 @@ public : //////////////////////////////////////////////////////////// /// \brief Unlock the mutex /// - /// \see Lock + /// \see lock /// //////////////////////////////////////////////////////////// void unlock(); diff --git a/include/SFML/Window/VideoMode.hpp b/include/SFML/Window/VideoMode.hpp index 4f0978a5f..57353909f 100644 --- a/include/SFML/Window/VideoMode.hpp +++ b/include/SFML/Window/VideoMode.hpp @@ -201,7 +201,7 @@ SFML_WINDOW_API bool operator >=(const VideoMode& left, const VideoMode& right); /// getFullscreenModes(). /// /// A custom video mode can also be checked directly for -/// fullscreen compatibility with its IsValid() function. +/// fullscreen compatibility with its isValid() function. /// /// Additionnally, sf::VideoMode provides a static function /// to get the mode currently used by the desktop: getDesktopMode().