Updated docs

[sdlgit/SDL-Site.git] / pages / SDL-Version.html-inc

diff --git a/pages/SDL-Version.html-inc b/pages/SDL-Version.html-inc
index 8210c41..512c582 100644 (file)
--- a/pages/SDL-Version.html-inc
+++ b/pages/SDL-Version.html-inc
@@ -18,7 +18,7 @@
 
 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="NAME_CONTENT">
-<p>SDL::Version -- SDL Bindings for structure SDL_Version</p>
+<p>SDL::Version - SDL Bindings for structure SDL_Version</p>
 
 </div>
 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
@@ -32,13 +32,13 @@
  use SDL::Version;
 
  # print compile-time version
- printf(&quot;SDL::version is %d.%d.%d\n&quot;, SDL::version-&gt;major, 
+ printf(&quot;SDL::version is %d.%d.%d\n&quot;, SDL::version-&gt;major,
                                       SDL::version-&gt;minor,
-                                      SDL::version-&gt;patch); 
+                                      SDL::version-&gt;patch);
 
  # print linked version
- printf(&quot;SDL::linked_version is %d.%d.%d\n&quot;, SDL::linked_version-&gt;major, 
-                                             SDL::linked_version-&gt;minor, 
+ printf(&quot;SDL::linked_version is %d.%d.%d\n&quot;, SDL::linked_version-&gt;major,
+                                             SDL::linked_version-&gt;minor,
                                              SDL::linked_version-&gt;patch);
 
 </pre>
@@ -46,8 +46,10 @@
 </div>
 <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="DESCRIPTION_CONTENT">
-<p>The <code>SDL::Version</code> structure is used by the <code>SDL::linked_version</code> function and the <code>SDL::version</code> macro. The <code>SDL::linked_version</code> function 
-returns the link-time SDL version whereas the <code>SDL::version</code> macro returns the compile-time SDL version. </p>
+<p>The <code>SDL::Version</code> structure is used by the <code>SDL::linked_version</code> function and the <code>SDL::version</code> macro.
+The <code>SDL::linked_version</code> function returns the link-time SDL version whereas <code>SDL::version</code> returns the compile-time SDL version.
+<strong>Note:</strong> This is the SDL version, not the SDL_Perl version.
+The SDL_Perl version is in <code>$SDL::VERSION</code>.</p>
 
 </div>
 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
@@ -56,17 +58,17 @@ returns the link-time SDL version whereas the <code>SDL::version</code> macro re
 </div>
 <h2 id="major">major</h2>
 <div id="major_CONTENT">
-<p>Major version number</p>
+<p>Returns the major version number.</p>
 
 </div>
 <h2 id="minor">minor</h2>
 <div id="minor_CONTENT">
-<p>Minor version number</p>
+<p>Returns the minor version number.</p>
 
 </div>
 <h2 id="patch">patch</h2>
 <div id="patch_CONTENT">
-<p>Patch version number</p>
+<p>Returns the patch version number.</p>
 
 </div>
 </div>
\ No newline at end of file