Improved API documentation (copied from SFML)

src/SFML/Audio/Music.cpp

@@ -30,8 +30,6 @@
 #include <SFML/Internal.h>
 
 
-////////////////////////////////////////////////////////////
-/// Create a new music and load it from a file
 ////////////////////////////////////////////////////////////
 sfMusic* sfMusic_CreateFromFile(const char* filename)
 {
@@ -46,8 +44,6 @@ sfMusic* sfMusic_CreateFromFile(const char* filename)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Create a new music and load it from a file in memory
 ////////////////////////////////////////////////////////////
 sfMusic* sfMusic_CreateFromMemory(const void* data, size_t sizeInBytes)
 {
@@ -62,8 +58,6 @@ sfMusic* sfMusic_CreateFromMemory(const void* data, size_t sizeInBytes)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Create a new music and load it from a custom stream
 ////////////////////////////////////////////////////////////
 sfMusic* sfMusic_CreateFromStream(sfInputStream* stream)
 {
@@ -81,8 +75,6 @@ sfMusic* sfMusic_CreateFromStream(sfInputStream* stream)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Destroy an existing music
 ////////////////////////////////////////////////////////////
 void sfMusic_Destroy(sfMusic* music)
 {
@@ -90,8 +82,6 @@ void sfMusic_Destroy(sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Set a music loop state
 ////////////////////////////////////////////////////////////
 void sfMusic_SetLoop(sfMusic* music, sfBool loop)
 {
@@ -99,8 +89,6 @@ void sfMusic_SetLoop(sfMusic* music, sfBool loop)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Tell whether or not a music is looping
 ////////////////////////////////////////////////////////////
 sfBool sfMusic_GetLoop(const sfMusic* music)
 {
@@ -108,8 +96,6 @@ sfBool sfMusic_GetLoop(const sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Get a music duration
 ////////////////////////////////////////////////////////////
 sfUint32 sfMusic_GetDuration(const sfMusic* music)
 {
@@ -117,8 +103,6 @@ sfUint32 sfMusic_GetDuration(const sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Start playing a music
 ////////////////////////////////////////////////////////////
 void sfMusic_Play(sfMusic* music)
 {
@@ -126,8 +110,6 @@ void sfMusic_Play(sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Pause a music
 ////////////////////////////////////////////////////////////
 void sfMusic_Pause(sfMusic* music)
 {
@@ -135,8 +117,6 @@ void sfMusic_Pause(sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Stop playing a music
 ////////////////////////////////////////////////////////////
 void sfMusic_Stop(sfMusic* music)
 {
@@ -144,8 +124,6 @@ void sfMusic_Stop(sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Return the number of channels of a music (1 = mono, 2 = stereo)
 ////////////////////////////////////////////////////////////
 unsigned int sfMusic_GetChannelsCount(const sfMusic* music)
 {
@@ -153,8 +131,6 @@ unsigned int sfMusic_GetChannelsCount(const sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Get the stream sample rate of a music
 ////////////////////////////////////////////////////////////
 unsigned int sfMusic_GetSampleRate(const sfMusic* music)
 {
@@ -162,8 +138,6 @@ unsigned int sfMusic_GetSampleRate(const sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Get the status of a music (stopped, paused, playing)
 ////////////////////////////////////////////////////////////
 sfSoundStatus sfMusic_GetStatus(const sfMusic* music)
 {
@@ -173,8 +147,6 @@ sfSoundStatus sfMusic_GetStatus(const sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Get the current playing position of a music
 ////////////////////////////////////////////////////////////
 sfUint32 sfMusic_GetPlayingOffset(const sfMusic* music)
 {
@@ -182,8 +154,6 @@ sfUint32 sfMusic_GetPlayingOffset(const sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Set the pitch of a music
 ////////////////////////////////////////////////////////////
 void sfMusic_SetPitch(sfMusic* music, float pitch)
 {
@@ -191,8 +161,6 @@ void sfMusic_SetPitch(sfMusic* music, float pitch)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Set the volume of a music
 ////////////////////////////////////////////////////////////
 void sfMusic_SetVolume(sfMusic* music, float volume)
 {
@@ -200,8 +168,6 @@ void sfMusic_SetVolume(sfMusic* music, float volume)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Set the position of a music
 ////////////////////////////////////////////////////////////
 void sfMusic_SetPosition(sfMusic* music, float x, float y, float z)
 {
@@ -209,10 +175,6 @@ void sfMusic_SetPosition(sfMusic* music, float x, float y, float z)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Make the music's position relative to the listener's
-/// position, or absolute.
-/// The default value is false (absolute)
 ////////////////////////////////////////////////////////////
 void sfMusic_SetRelativeToListener(sfMusic* music, sfBool relative)
 {
@@ -220,10 +182,6 @@ void sfMusic_SetRelativeToListener(sfMusic* music, sfBool relative)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Set the minimum distance - closer than this distance,
-/// the listener will hear the music at its maximum volume.
-/// The default minimum distance is 1.0
 ////////////////////////////////////////////////////////////
 void sfMusic_SetMinDistance(sfMusic* music, float distance)
 {
@@ -231,10 +189,6 @@ void sfMusic_SetMinDistance(sfMusic* music, float distance)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Set the attenuation factor - the higher the attenuation, the
-/// more the sound will be attenuated with distance from listener.
-/// The default attenuation factor 1.0
 ////////////////////////////////////////////////////////////
 void sfMusic_SetAttenuation(sfMusic* music, float attenuation)
 {
@@ -242,8 +196,6 @@ void sfMusic_SetAttenuation(sfMusic* music, float attenuation)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Set the current playing position of a stream
 ////////////////////////////////////////////////////////////
 void sfMusic_SetPlayingOffset(sfMusic* music, sfUint32 timeOffset)
 {
@@ -251,8 +203,6 @@ void sfMusic_SetPlayingOffset(sfMusic* music, sfUint32 timeOffset)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Get the pitch of a music
 ////////////////////////////////////////////////////////////
 float sfMusic_GetPitch(const sfMusic* music)
 {
@@ -260,8 +210,6 @@ float sfMusic_GetPitch(const sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Get the volume of a music
 ////////////////////////////////////////////////////////////
 float sfMusic_GetVolume(const sfMusic* music)
 {
@@ -269,8 +217,6 @@ float sfMusic_GetVolume(const sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Get the position of a music
 ////////////////////////////////////////////////////////////
 void sfMusic_GetPosition(const sfMusic* music, float* x, float* y, float* z)
 {
@@ -286,9 +232,6 @@ void sfMusic_GetPosition(const sfMusic* music, float* x, float* y, float* z)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Tell if the music's position is relative to the listener's
-/// position, or if it's absolute
 ////////////////////////////////////////////////////////////
 CSFML_API sfBool sfMusic_IsRelativeToListener(const sfMusic* music)
 {
@@ -296,8 +239,6 @@ CSFML_API sfBool sfMusic_IsRelativeToListener(const sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Get the minimum distance of a music
 ////////////////////////////////////////////////////////////
 float sfMusic_GetMinDistance(const sfMusic* music)
 {
@@ -305,8 +246,6 @@ float sfMusic_GetMinDistance(const sfMusic* music)
 }
 
 
-////////////////////////////////////////////////////////////
-/// Get the attenuation factor of a music
 ////////////////////////////////////////////////////////////
 float sfMusic_GetAttenuation(const sfMusic* music)
 {