From: Tobias Leich Date: Thu, 19 Nov 2009 16:31:25 +0000 (+0100) Subject: docs X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=b82df1356a6be5ab828d198947fe0e5b76efd735;p=sdlgit%2FSDL-Site.git docs --- diff --git a/pages/SDL-Audio.html-inc b/pages/SDL-Audio.html-inc new file mode 100644 index 0000000..32bb3fb --- /dev/null +++ b/pages/SDL-Audio.html-inc @@ -0,0 +1,21 @@ +
+ +

Index

+ +
+ + +

NAME

Top

+
+

SDL::Audio -- SDL Bindings for Audio

+ +
+

CATEGORY

Top

+
+

TODO, Core, Audio

+ +
+
\ No newline at end of file diff --git a/pages/SDL-AudioSpec.html-inc b/pages/SDL-AudioSpec.html-inc new file mode 100644 index 0000000..d8b7aea --- /dev/null +++ b/pages/SDL-AudioSpec.html-inc @@ -0,0 +1,21 @@ +
+ +

Index

+ +
+ + +

NAME

Top

+
+

SDL::AudioSpec -- SDL Bindings for structure SDL_AudioSpec

+ +
+

CATEGORY

Top

+
+

TODO, Core, Audio, Structure

+ +
+
\ No newline at end of file diff --git a/pages/SDL-CD.html-inc b/pages/SDL-CD.html-inc new file mode 100644 index 0000000..948fd94 --- /dev/null +++ b/pages/SDL-CD.html-inc @@ -0,0 +1,21 @@ +
+ +

Index

+ +
+ + +

NAME

Top

+
+

SDL::CD -- SDL Bindings for structure SDL_CD

+ +
+

CATEGORY

Top

+
+

TODO, Core, CDROM, Structure

+ +
+
\ No newline at end of file diff --git a/pages/SDL-CDTrack.html-inc b/pages/SDL-CDTrack.html-inc new file mode 100644 index 0000000..28a7b13 --- /dev/null +++ b/pages/SDL-CDTrack.html-inc @@ -0,0 +1,21 @@ +
+ +

Index

+ +
+ + +

NAME

Top

+
+

SDL::CDTrack -- SDL Bindings for structure SDL_CDTrack

+ +
+

CATEGORY

Top

+
+

TODO, Core, CDROM, Structure

+ +
+
\ No newline at end of file diff --git a/pages/SDL-Cdrom.html-inc b/pages/SDL-Cdrom.html-inc index 304c392..0421cec 100644 --- a/pages/SDL-Cdrom.html-inc +++ b/pages/SDL-Cdrom.html-inc @@ -3,149 +3,19 @@

Index

NAME

Top

-

SDL::Cdrom - a SDL perl extension for managing CD-ROM drives

- -
-

SYNOPSIS

Top

-
-
	use SDL::Cdrom;
-	$cdrom = SDL::Cdrom->new(0);
-	$cdrom->play();
-
-
- -
-

EXPORTS

Top

-
- - - -
-

DESCRIPTION

Top

-
-

Create a new SDL::Cdrom object. The passed $id is the number of the drive, -whereas 0 is the first drive etc.

-
	use SDL::Cdrom;
-	my $drive => SDL::Cdrom->new($id);
-
-
- -
-

METHODS

Top

-
- -
-

cd_num_drives()

-
-

Returns the number of CD-ROM drives present.

- -
-

name(cd)

-
-

Returns the system dependent name of the CD-ROM device. -It takes a SDL::Cdrom as first parameter.

- -
-

status(cd)

-
-

Return the status of the drive. -It takes a SDL::Cdrom as first parameter.

- -
-

play(cd,start,length,fs,fl)

-
-

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.

- -
-

pause(cd)

-
-

Pause the playing of the SDL::Cdrom given as first parameter. -It returns 1 on succés 0 on error.

- -
-

resume(cd)

-
-

Resume the playing of the SDL::Cdrom given as first parameter. -It returns 1 on succés 0 on error.

- -
-

stop(cd)

-
-

Stop the playing of the SDL::Cdrom given as first parameter. -It returns 1 on succés 0 on error.

- -
-

eject(cd)

-
-

Eject the medium in the SDL::Cdrom given as first parameter. -It returns 1 on succés 0 on error.

- -
-

id(cd)

-
-

Return the ID of the drive given as first parameter.

- -
-

num_tracks(cd)

-
-

Return the number of tracks on the SDL::Cdrom given as first parameter.

- -
-

track(cd,number)

-
-

Returns the track description of the track given as second parameter. -the first parameter is a SDL:Cdrom.

- -
-

current(cd)

-
-

Return the current played track number given as first parameter.

- -
-

current_frame(cd)

-
-

Return the current frame given as first parameter.

- -
-

AUTHORS

Top

-
-

David J. Goehrig -Documentation by Tels <http://bloodgate.com/>.

+

SDL::CDROM -- SDL Bindings for the CDROM device

-

SEE ALSO

Top

-
-

perl SDL::Mixer SDL::App.

+

CATEGORY

Top

+
+

TODO, Core, CDROM

\ No newline at end of file diff --git a/pages/SDL-Joystick.html-inc b/pages/SDL-Joystick.html-inc new file mode 100644 index 0000000..a6a7a66 --- /dev/null +++ b/pages/SDL-Joystick.html-inc @@ -0,0 +1,21 @@ +
+ +

Index

+ +
+ + +

NAME

Top

+
+

SDL::Joystick -- SDL Bindings for the Joystick device

+ +
+

CATEGORY

Top

+
+

TODO, Core, Joystick

+ +
+
\ No newline at end of file diff --git a/pages/SDL-Mixer-MixChunk.html-inc b/pages/SDL-Mixer-MixChunk.html-inc new file mode 100644 index 0000000..a9278bb --- /dev/null +++ b/pages/SDL-Mixer-MixChunk.html-inc @@ -0,0 +1,21 @@ +
+ +

Index

+ +
+ + +

NAME

Top

+
+

SDL::MixChunk -- SDL Bindings for structure SDL_MixChunk

+ +
+

CATEGORY

Top

+
+

TODO, Core, Mixer, Structure

+ +
+
\ No newline at end of file diff --git a/pages/SDL-Mixer-MixMusic.html-inc b/pages/SDL-Mixer-MixMusic.html-inc new file mode 100644 index 0000000..636bad0 --- /dev/null +++ b/pages/SDL-Mixer-MixMusic.html-inc @@ -0,0 +1,21 @@ +
+ +

Index

+ +
+ + +

NAME

Top

+
+

SDL::MixMusic -- SDL Bindings for structure SDL_MixMusic

+ +
+

CATEGORY

Top

+
+

TODO, Core, Mixer, Structure

+ +
+
\ No newline at end of file diff --git a/pages/SDL-Mouse.html-inc b/pages/SDL-Mouse.html-inc new file mode 100644 index 0000000..2e6645c --- /dev/null +++ b/pages/SDL-Mouse.html-inc @@ -0,0 +1,21 @@ +
+ +

Index

+ +
+ + +

NAME

Top

+
+

SDL::Mouse -- SDL Bindings for the Mouse device

+ +
+

CATEGORY

Top

+
+

TODO, Core, Mouse

+ +
+
\ No newline at end of file diff --git a/pages/SDL-Version.html-inc b/pages/SDL-Version.html-inc new file mode 100644 index 0000000..29def17 --- /dev/null +++ b/pages/SDL-Version.html-inc @@ -0,0 +1,21 @@ +
+ +

Index

+ +
+ + +

NAME

Top

+
+

SDL::Version -- SDL Bindings for structure SDL_Version

+ +
+

CATEGORY

Top

+
+

TODO, Core, Structure

+ +
+
\ No newline at end of file diff --git a/pages/documentation.html-inc b/pages/documentation.html-inc index 4f9125d..afda4d3 100644 --- a/pages/documentation.html-inc +++ b/pages/documentation.html-inc @@ -1,2 +1,2 @@
-

Documentation (latest development branch)

Core
thumbSDL Simple DirectMedia Layer for Perl
Events
thumbSDL::Events Bindings to the Events Category in SDL API
Structure
thumbSDL::Event General event structure
MultiThread
thumbSDL::MultiThread Bindings to the MultiThread category in SDL API
Video
thumbSDL::Video Bindings to the video category in SDL API
Structure
thumbSDL::Color Format independent color description
thumbSDL::Overlay YUV Video overlay
thumbSDL::PixelFormat Stores surface format information
thumbSDL::Rect Defines a rectangular area
thumbSDL::Surface
thumbSDL::VideoInfo Video Target Information

Cookbook
thumbSDL::Cookbook
thumbSDL::Cookbook::PDL

Extension
thumbSDL::App a SDL perl extension

Mixer
thumbSDL::Mixer a SDL perl extension

Tutorials
thumbSDL::Tutorial introduction to Perl SDL
thumbSDL::Tutorial::Animation
thumbSDL::Tutorial::Images
thumbSDL::Tutorial::LunarLander a small tutorial on Perl SDL
thumbSDL::Tutorial::Pong
thumbSDL::Tutorial::Tetris

UNCATEGORIZED
thumbSDL::Cdrom a SDL perl extension for managing CD-ROM drives
thumbSDL::Cursor a SDL perl extension
thumbSDL::Font a SDL perl extension
thumbSDL::Game::Palette a perl extension
thumbSDL::MPEG a SDL perl extension
thumbSDL::Music a perl extension
thumbSDL::OpenGL a perl extension
thumbSDL::Palette a perl extension
thumbSDL::SFont a perl extension
thumbSDL::SMPEG a SDL perl extension
thumbSDL::Sound a perl extension
thumbSDL::TTFont a SDL perl extension
thumbSDL::Timer a SDL perl extension to handle timers
thumbSDL::Tool::Font a perl extension
thumbSDL::Tool::Graphic
thumbTime a SDL perl extension for managing timers.
+

Documentation (latest development branch)

Core
thumbSDL Simple DirectMedia Layer for Perl
Events
thumbSDL::Events Bindings to the Events Category in SDL API
Structure
thumbSDL::Event General event structure
MultiThread
thumbSDL::MultiThread Bindings to the MultiThread category in SDL API
Video
thumbSDL::Video Bindings to the video category in SDL API
Structure
thumbSDL::Color Format independent color description
thumbSDL::Overlay YUV Video overlay
thumbSDL::PixelFormat Stores surface format information
thumbSDL::Rect Defines a rectangular area
thumbSDL::Surface
thumbSDL::VideoInfo Video Target Information

Cookbook
thumbSDL::Cookbook
thumbSDL::Cookbook::PDL

Extension
thumbSDL::App a SDL perl extension

Mixer
thumbSDL::Mixer a SDL perl extension
TODO
Core
Audio
thumbSDL::Audio- SDL Bindings for Audio
Structure
thumbSDL::AudioSpec- SDL Bindings for structure SDL_AudioSpec
CDROM
thumbSDL::CDROM- SDL Bindings for the CDROM device
Structure
thumbSDL::CD- SDL Bindings for structure SDL_CD
thumbSDL::CDTrack- SDL Bindings for structure SDL_CDTrack
Joystick
thumbSDL::Joystick- SDL Bindings for the Joystick device
Structure
thumbSDL::Mixer::MixChunk- SDL Bindings for structure SDL_MixChunk
thumbSDL::Mixer::MixMusic- SDL Bindings for structure SDL_MixMusic
Mouse
thumbSDL::Mouse- SDL Bindings for the Mouse device
Structure
thumbSDL::Version- SDL Bindings for structure SDL_Version

Tutorials
thumbSDL::Tutorial introduction to Perl SDL
thumbSDL::Tutorial::Animation
thumbSDL::Tutorial::Images
thumbSDL::Tutorial::LunarLander a small tutorial on Perl SDL
thumbSDL::Tutorial::Pong
thumbSDL::Tutorial::Tetris

UNCATEGORIZED
thumbSDL::Cursor a SDL perl extension
thumbSDL::Font a SDL perl extension
thumbSDL::Game::Palette a perl extension
thumbSDL::MPEG a SDL perl extension
thumbSDL::Music a perl extension
thumbSDL::OpenGL a perl extension
thumbSDL::Palette a perl extension
thumbSDL::SFont a perl extension
thumbSDL::SMPEG a SDL perl extension
thumbSDL::Sound a perl extension
thumbSDL::TTFont a SDL perl extension
thumbSDL::Timer a SDL perl extension to handle timers
thumbSDL::Tool::Font a perl extension
thumbSDL::Tool::Graphic
thumbTime a SDL perl extension for managing timers.
diff --git a/tools/PM-Pod2html-snippet.pl b/tools/PM-Pod2html-snippet.pl index 5388059..b1393dd 100644 --- a/tools/PM-Pod2html-snippet.pl +++ b/tools/PM-Pod2html-snippet.pl @@ -38,6 +38,35 @@ for my $key (sort keys %files) my @matches = ( $files{$key}{'section'} =~ m/\w+/xg ); + if($#matches) + { + my $section_path = ''; + my $doit = 1; + + for my $section (@matches) + { + last if $section eq $matches[$#matches]; + + $section_path .= (length($section_path) ? ', ' : '') . $section; + + if($last_section =~ /^$section_path/) + { + $doit = 0; + } + } + + if($doit) + { + my @this_matches = ( $section_path =~ m/\w+/xg ); + my $i = 0; + for my $this_section (@this_matches) + { + printf($fh '', + $i++ * 30, $this_section); + } + } + } + if($last_section ne $files{$key}{'section'}) { print ($fh '
%s
') if $last_section;