From: Kartik Thakore Date: Sun, 1 Nov 2009 00:30:31 +0000 (-0400) Subject: added more docs update X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=472bc0a169396340021b2413bacd40027c274f76;p=sdlgit%2FSDL_perl.git added more docs update --- diff --git a/lib/docs/Cdrom.pod b/lib/docs/Cdrom.pod index e6582bc..6f6a82f 100644 --- a/lib/docs/Cdrom.pod +++ b/lib/docs/Cdrom.pod @@ -1,7 +1,5 @@ =pod - - =head1 NAME SDL::Cdrom - a SDL perl extension for managing CD-ROM drives @@ -36,53 +34,61 @@ whereas 0 is the first drive etc. Returns the number of CD-ROM drives present. -=head2 name() +=head2 name(cd) Returns the system dependent name of the CD-ROM device. +It takes a SDL::Cdrom as first parameter. -=head2 status() +=head2 status(cd) Return the status of the drive. +It takes a SDL::Cdrom as first parameter. -=head2 play() +=head2 play(cd,start,length,fs,fl) -Play a track. +Play a track from the SDL::Cdrom given as first parameter, second parameter is the frame to start, the third is the lenght to play. +It returns 1 on succés 0 on error. -=head2 pause() +=head2 pause(cd) -Pause the playing. +Pause the playing of the SDL::Cdrom given as first parameter. +It returns 1 on succés 0 on error. -=head2 resume() +=head2 resume(cd) -Resume the playing. +Resume the playing of the SDL::Cdrom given as first parameter. +It returns 1 on succés 0 on error. -=head2 stop() +=head2 stop(cd) -Stop the playing. +Stop the playing of the SDL::Cdrom given as first parameter. +It returns 1 on succés 0 on error. -=head2 eject() +=head2 eject(cd) -Eject the medium in the drive. +Eject the medium in the SDL::Cdrom given as first parameter. +It returns 1 on succés 0 on error. -=head2 id() +=head2 id(cd) -Return the ID of the drive. +Return the ID of the drive given as first parameter. -=head2 num_tracks() +=head2 num_tracks(cd) -Return the number of tracks on the medium. +Return the number of tracks on the SDL::Cdrom given as first parameter. -=head2 track() +=head2 track(cd,number) -Returns the track description +Returns the track description of the track given as second parameter. +the first parameter is a SDL:Cdrom. -=head2 current() +=head2 current(cd) -Return the current played track number. +Return the current played track number given as first parameter. -=head2 current_frame() +=head2 current_frame(cd) -Return the current frame. +Return the current frame given as first parameter. =head1 AUTHORS diff --git a/lib/docs/Cursor.pod b/lib/docs/Cursor.pod index 0528766..79511ad 100644 --- a/lib/docs/Cursor.pod +++ b/lib/docs/Cursor.pod @@ -1,7 +1,5 @@ =pod - - =head1 NAME SDL::Cursor - a SDL perl extension @@ -26,13 +24,16 @@ white. Creates a new cursor. The -data and -mask parameters should be both black and white pictures. The height and width of these surfaces should be a multiple of 8. The -x and -y are the coordinates of the cursor 'hot spot'. -=head2 warp($x, $y) +=head2 warp(cursor,x, y) -Set the position of the cursor at the $x, $y coordinates in the application window. +Set the position of the SDL::Cursor given as first parameter . +the new postion is set to x, y coordinates in the application window. +SDL::warp trigger a new mouse motion event. +It doesn't returns anything. -=head2 use() +=head2 use(cursor) -Set the cursor as the active cursor. +Set the SDL::Cursor given as first parameter to the active cursor. =head2 get() diff --git a/lib/docs/Event.pod b/lib/docs/Event.pod index 0449b04..6d5e35f 100644 --- a/lib/docs/Event.pod +++ b/lib/docs/Event.pod @@ -45,9 +45,9 @@ See also L. Create a new event object.It returns a SDL::Event. -=head2 type() +=head2 type(event) -Returns the type of the event, see list of exported symbols for which are +Returns the type of the SDL::Event given as first parameter, see list of exported symbols for which are available. =head2 pump() diff --git a/lib/docs/Font.pod b/lib/docs/Font.pod index 8f764ed..e20bebe 100644 --- a/lib/docs/Font.pod +++ b/lib/docs/Font.pod @@ -1,6 +1,5 @@ =pod - =head1 NAME SDL::Font - a SDL perl extension @@ -15,6 +14,12 @@ SDL::Font - a SDL perl extension L provides an interface to loading and using SFont style fonts with L objects. +=head1 METHOD + +=head2 use(font) + +Use the SDL::Font given as first parameter. + =head1 AUTHOR David J. Goehrig diff --git a/lib/docs/MPEG.pm b/lib/docs/MPEG.pod similarity index 99% rename from lib/docs/MPEG.pm rename to lib/docs/MPEG.pod index c948f98..db2c8c8 100644 --- a/lib/docs/MPEG.pm +++ b/lib/docs/MPEG.pod @@ -1,6 +1,5 @@ =pod - =head1 NAME SDL::MPEG - a SDL perl extension