lauchmelder/SFML
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added commentaries to all new initialize methods.

Browse source 
Also moved the commentaries in SFML::Window from the Window_New function to Window_Initialize.

git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1746 4e206d99-4929-0410-ac5d-dfc041789085
This commit is contained in:
groogy 2010-12-04 21:17:35 +00:00
parent aa39447c26
commit 0aafc6b6ba
7 changed files with 60 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

7
bindings/ruby/sfml-audio/audio/Music.cpp
View file

@ -58,9 +58,12 @@ static VALUE Music_OpenFromFile( VALUE self, VALUE aFilename )
}
/* call-seq:
* Music.new() -> music
* Music.new() -> music
* Music.new( filename ) -> music
*
* Creates a new music instance.
* Will create a new music instance.
*
* If a filename argument is specified then music#openFromFile will be called on the created instance.
*/
static VALUE Music_Initialize( int argc, VALUE *args, VALUE self )
{

11
bindings/ruby/sfml-audio/audio/SoundBuffer.cpp
View file

@ -193,6 +193,17 @@ static VALUE SoundBuffer_GetDuration( VALUE self )
return rb_float_new( object->GetDuration() );
}
/* call-seq:
* SoundBuffer.new() -> sound_buffer
* SoundBuffer.new( filename ) -> sound_buffer
* SoundBuffer.new( samples, samplesCount, channelsCount, sampleRate ) -> sound_buffer
*
* Will create a new sound buffer instance.
*
* If a filename argument is specified then sound_buffer#loadFromFile will be called on the created instance. If
* samples, samplesCount, channelsCount and sampleRate are specified then image#loadFromPixels will be called on the
* created instance.
*/
static VALUE SoundBuffer_Initialize( int argc, VALUE *args, VALUE self )
{
if( argc > 1 )