Minor corrections in API documentation

This commit is contained in:
Marco Antognini 2012-08-23 12:34:51 +02:00
parent 757a785ed7
commit f970a6441f
13 changed files with 27 additions and 27 deletions

View File

@ -83,7 +83,7 @@ public :
/// This function uses its own thread so that it doesn't block /// This function uses its own thread so that it doesn't block
/// the rest of the program while the sound is played. /// the rest of the program while the sound is played.
/// ///
/// \see Pause, Stop /// \see pause, stop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void play(); void play();
@ -94,19 +94,19 @@ public :
/// This function pauses the sound if it was playing, /// This function pauses the sound if it was playing,
/// otherwise (sound already paused or stopped) it has no effect. /// otherwise (sound already paused or stopped) it has no effect.
/// ///
/// \see Play, Stop /// \see play, stop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void pause(); void pause();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Stop playing the sound /// \brief stop playing the sound
/// ///
/// This function stops the sound if it was playing or paused, /// This function stops the sound if it was playing or paused,
/// and does nothing if it was already stopped. /// and does nothing if it was already stopped.
/// It also resets the playing position (unlike pause()). /// It also resets the playing position (unlike pause()).
/// ///
/// \see Play, Pause /// \see play, pause
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void stop(); void stop();
@ -120,7 +120,7 @@ public :
/// ///
/// \param buffer Sound buffer to attach to the sound /// \param buffer Sound buffer to attach to the sound
/// ///
/// \see GetBuffer /// \see getBuffer
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void setBuffer(const SoundBuffer& buffer); void setBuffer(const SoundBuffer& buffer);

View File

@ -117,10 +117,10 @@ private :
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
/// if (SoundBufferRecorder::isAvailable()) /// if (sf::SoundBufferRecorder::isAvailable())
/// { /// {
/// // Record some audio data /// // Record some audio data
/// SoundBufferRecorder recorder; /// sf::SoundBufferRecorder recorder;
/// recorder.start(); /// recorder.start();
/// ... /// ...
/// recorder.stop(); /// recorder.stop();

View File

@ -215,7 +215,7 @@ private :
/// ///
/// The audio capture feature may not be supported or activated /// The audio capture feature may not be supported or activated
/// on every platform, thus it is recommended to check its /// 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. /// false, then any attempt to use an audio recorder will fail.
/// ///
/// It is important to note that the audio capture happens in a /// It is important to note that the audio capture happens in a

View File

@ -96,7 +96,7 @@ public :
/// ///
/// The result is undefined if \a index is out of the valid range. /// 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 /// \return Index-th point of the shape
/// ///

View File

@ -78,11 +78,11 @@ public :
/// ///
/// Don't forget that the polygon must remain convex, and /// Don't forget that the polygon must remain convex, and
/// the points need to stay ordered! /// 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 /// number of points. The result is undefined if \a index is out
/// of the valid range. /// 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 /// \param point New position of the point
/// ///
/// \see getPoint /// \see getPoint
@ -95,7 +95,7 @@ public :
/// ///
/// The result is undefined if \a index is out of the valid range. /// 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 /// \return Position of the index-th point of the polygon
/// ///

View File

@ -83,7 +83,7 @@ public :
/// ///
/// The result is undefined if \a index is out of the valid range. /// 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 /// \return Index-th point of the shape
/// ///

View File

@ -201,7 +201,7 @@ public :
/// ///
/// The result is undefined if \a index is out of the valid range. /// 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 /// \return Index-th point of the shape
/// ///

View File

@ -397,18 +397,18 @@ private :
/// class MyEntity /// class MyEntity
/// { /// {
/// public : /// 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 : /// private :
/// sf::Transformable myTransform; /// sf::Transformable m_transform;
/// }; /// };
/// \endcode /// \endcode
/// ///

View File

@ -75,7 +75,7 @@ public :
/// \brief Get a read-write access to a vertex by its index /// \brief Get a read-write access to a vertex by its index
/// ///
/// This function doesn't check \a index, it must be in range /// 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. /// otherwise.
/// ///
/// \param index Index of the vertex to get /// \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 /// \brief Get a read-only access to a vertex by its index
/// ///
/// This function doesn't check \a index, it must be in range /// 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. /// otherwise.
/// ///
/// \param index Index of the vertex to get /// \param index Index of the vertex to get

View File

@ -340,7 +340,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Construct the HTTP client with the target host /// \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 /// The port has a default value of 0, which means that the
/// HTTP client will use the right port according to the /// HTTP client will use the right port according to the
/// protocol used (80 for HTTP, 443 for HTTPS). You should /// 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. /// \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 /// Any missing mandatory header field in the request will be added
/// with an appropriate value. /// with an appropriate value.
/// Warning: this function waits for the server's response and may /// Warning: this function waits for the server's response and may

View File

@ -227,7 +227,7 @@ private:
/// ///
/// When a socket is connected to a remote host, you can /// When a socket is connected to a remote host, you can
/// retrieve informations about this host with the /// 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 /// also get the local port to which the socket is bound
/// (which is automatically chosen when the socket is connected), /// (which is automatically chosen when the socket is connected),
/// with the getLocalPort function. /// with the getLocalPort function.

View File

@ -67,7 +67,7 @@ public :
/// this call will block the execution until the mutex /// this call will block the execution until the mutex
/// is released. /// is released.
/// ///
/// \see Unlock /// \see unlock
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void lock(); void lock();
@ -75,7 +75,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Unlock the mutex /// \brief Unlock the mutex
/// ///
/// \see Lock /// \see lock
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void unlock(); void unlock();

View File

@ -201,7 +201,7 @@ SFML_WINDOW_API bool operator >=(const VideoMode& left, const VideoMode& right);
/// getFullscreenModes(). /// getFullscreenModes().
/// ///
/// A custom video mode can also be checked directly for /// 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 /// Additionnally, sf::VideoMode provides a static function
/// to get the mode currently used by the desktop: getDesktopMode(). /// to get the mode currently used by the desktop: getDesktopMode().