Applied Magnet's Patch

[sdlgit/SDL_perl.git] / lib / docs / Music.pod

diff --git a/lib/docs/Music.pod b/lib/docs/Music.pod
new file mode 100644 (file)
index 0000000..0a17e2c
--- /dev/null
+++ b/lib/docs/Music.pod
@@ -0,0 +1,24 @@
+=pod
+
+=head1 NAME
+
+SDL::Music - a perl extension
+
+=head1 DESCRIPTION
+
+L<SDL::Music> is used to load music files for use with L<SDL::Mixer>.
+To load a music file one simply creates a new object passing the filename 
+to the constructor:
+
+       my $music = new SDL::Music 'my_song.ogg';
+
+
+=head1 AUTHOR
+
+David J. Goehrig
+
+=head1 SEE ALSO
+
+L<perl> L<SDL::Mixer>
+
+=cut