Minor corrections in API documentation
This commit is contained in:
parent
757a785ed7
commit
f970a6441f
13 changed files with 27 additions and 27 deletions
|
@ -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);
|
||||
|
|
|
@ -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();
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue