docs
[sdlgit/SDL-Site.git] / pages / SDL.html-inc
index 34e5c9f..533dad4 100644 (file)
@@ -2,7 +2,10 @@
 <!-- INDEX START -->
 <h3 id="TOP">Index</h3>
 
-<ul><li><a href="#NAME">NAME</a></li>
+<ul><li><a href="#NAME">NAME</a>
+<ul><li><a href="#CATEGORY">CATEGORY</a></li>
+</ul>
+</li>
 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
 <li><a href="#The_SDL_Perl_2009_Development_Team">The SDL Perl 2009 Development Team</a>
 <li><a href="#version">version()</a></li>
 <li><a href="#linked_version">linked_version</a></li>
 <li><a href="#get_error-2">get_error()</a></li>
-<li><a href="#delay_ms">delay(ms)</a>
-</li>
+<li><a href="#delay_ms">delay(ms)</a></li>
 </ul>
 </li>
+<li><a href="#STUFF_TO_BE_DONE_for_the_documentati">STUFF TO BE DONE for the documentation</a>
+</li>
 </ul><hr />
 <!-- INDEX END -->
 
 <p>SDL_perl - Simple DirectMedia Layer for Perl</p>
 
 </div>
+<h2 id="CATEGORY">CATEGORY</h2>
+<div id="CATEGORY_CONTENT">
+<p>Core</p>
+
+</div>
 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="SYNOPSIS_CONTENT">
 <pre>  use SDL;
@@ -198,24 +207,47 @@ it doesn't returns any values.</p>
 <div id="error_code_need_to_be_coded_CONTENT">
 <p>Sets the SDL error message to one of several predefined strings specified by code. </p>
 <p>code can be :</p>
-<pre>          SDL_errorcode   The corresponding error string
-
-               SDL_ENOMEM      Out of memory
-               SDL_EFREAD      Error reading from datastream
-               SDL_EFWRITE     Error writing to datastream
-               SDL_EFSEEK      Error seeking in datastream
-               SDL_UNSUPPORTED Unknown SDL error
-               SDL_LASTERROR   Unknown SDL error
-               any other value Unknown SDL error
-
+<dl>
+       <dt>SDL_errorcode</dt>
+       <dd>
+               <p>The corresponding error string</p>
+       </dd>
+       <dt>SDL_ENOMEM</dt>
+       <dd>
+               <p>Out of memory</p>
+       </dd>
+       <dt>SDL_EFREAD</dt>
+       <dd>
+               <p>Error reading from datastream</p>
+       </dd>
+       <dt>SDL_EFWRITE</dt>
+       <dd>
+               <p>Error writing to datastream</p>
+       </dd>
+       <dt>SDL_EFSEEK</dt>
+       <dd>
+               <p>Error seeking in datastream</p>
+       </dd>
+       <dt>SDL_UNSUPPORTED</dt>
+       <dd>
+               <p>Unknown SDL error</p>
+       </dd>
+       <dt>SDL_LASTERROR</dt>
+       <dd>
+               <p>Unknown SDL error</p>
+       </dd>
+       <dt>any other value</dt>
+       <dd>
+               <p>Unknown SDL error</p>
+       </dd>
+</dl>
 
 
 
-               Note 1: SDL_LASTERROR marks the highest numbered predefined error.
-               Note 2: SDL also defines SDL_OutOfMemory() and SDL_Unsupported() for internal use
-               which are equivalent to SDL_Error(SDL_ENOMEM) and SDL_Error(SDL_UNSUPPORTED) respectively. 
 
-</pre>
+<p>Note 1: SDL_LASTERROR marks the highest numbered predefined error.
+Note 2: SDL also defines SDL_OutOfMemory() and SDL_Unsupported() for internal use
+which are equivalent to SDL_Error(SDL_ENOMEM) and SDL_Error(SDL_UNSUPPORTED) respectively. </p>
 <p>SDL::Error doesn't returns any value.</p>
 
 
@@ -275,8 +307,25 @@ than the specified depending on the underlying OS.</p>
 
 
 
+</div>
+<h1 id="STUFF_TO_BE_DONE_for_the_documentati">STUFF TO BE DONE for the documentation</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="STUFF_TO_BE_DONE_for_the_documentati-2">
+<pre>
+
+
+       SDL:: to improve
+       SDL::Video add examples, need general improvement.
+       Event.pod need to be checked against Events.pod
+       SDL::Events need to be completed
+       SDL::Cdrom need some examples. 
+       SDL::MultiThread to be created( once implemented  ). 
+       SDL::Timer need examples. 
+       SDL::RW to be created.
+       SDL::Mouse need to be created.
+       SDL::Joystick need to be created.
+       SDL::Audio need to be created.
 
-
+</pre>
 
 </div>
 </div>
\ No newline at end of file