NativeWindow API Doc: Fix layout / Add version.

author: Sven Gothel <[email protected]> 2013-07-17 16:15:32 +0200
committer: Sven Gothel <[email protected]> 2013-07-17 16:15:32 +0200
commit: 5dc0e8c2bfc686ccac0902ff09448cd2f3ad65b4 (patch)
tree: 12bdf8b828e21e951a64f9d7a662e4cab0ab7ff3 /src/nativewindow/classes
parent: cc63dc207f0b9f7ca53cbe3bc975b03773a257df (diff)
1 files changed, 39 insertions, 55 deletions
diff --git a/src/nativewindow/classes/javax/media/nativewindow/package.html b/src/nativewindow/classes/javax/media/nativewindow/package.html
index 14730a548..3fe42bab0 100644
--- a/src/nativewindow/classes/javax/media/nativewindow/package.html
+++ b/src/nativewindow/classes/javax/media/nativewindow/package.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <html>
 <head>
-  <title>NativeWindow Protocol Draft Public Review Specification</title>
+  <title>NativeWindow Specification Overview</title>
 </head>
   <body>
    
@@ -10,7 +10,7 @@
 <h3>Preface</h3>
   This specification, an optional set of packages, describing a <i>protocol</i> for a 
   <i>native windowing interface</i> binding to Java(TM).<br>
-  Currently specified <i>native windowing systems</i> are:<br><br>
+  Currently specified <i>native windowing systems</i> are:
   <ul>
     <li> EGL/OpenKODE Windowing System</li>
     <li> X11 Windowing System</li>
@@ -20,95 +20,79 @@
   </ul>
   <br>
   However, any other native windowing system may be added to the implementation,
-  using a generic string identifier and an optional specialisation of:<br><br>
+  using a generic string identifier and an optional specialisation of:
   <ul>
-    <li>{@link javax.media.nativewindow.AbstractGraphicsDevice AbstractGraphicsDevice},<br>
-       <br>
-       Shall return the new string identifier with {@link javax.media.nativewindow.AbstractGraphicsDevice#getType() getType()}</li>
+    <li>{@link javax.media.nativewindow.AbstractGraphicsDevice AbstractGraphicsDevice},
+        <p>Shall return the new string identifier with {@link javax.media.nativewindow.AbstractGraphicsDevice#getType() getType()}</p></li>
     <li>{@link javax.media.nativewindow.AbstractGraphicsScreen AbstractGraphicsScreen}</li>
     <li>{@link javax.media.nativewindow.AbstractGraphicsConfiguration AbstractGraphicsConfiguration}</li>
   </ul>
-  <br>
-  The implementor has to provide the following:<br><br>
+  <p>The implementor has to provide the following:</p>
   <ul>
-    <li> The specialisation of the abstract class {@link javax.media.nativewindow.NativeWindowFactory NativeWindowFactory}<br>
-         <br>
-         shall be registered with {@link javax.media.nativewindow.NativeWindowFactory#registerFactory NativeWindowFactory.registerFactory(..)}.</li>
+    <li> The specialisation of the abstract class {@link javax.media.nativewindow.NativeWindowFactory NativeWindowFactory}
+         <p>shall be registered with {@link javax.media.nativewindow.NativeWindowFactory#registerFactory NativeWindowFactory.registerFactory(..)}.</p></li>
 
-    <li> The specialisation of the abstract class {@link javax.media.nativewindow.GraphicsConfigurationFactory GraphicsConfigurationFactory}<br>
-         <br>
-         shall be registered with {@link javax.media.nativewindow.GraphicsConfigurationFactory#registerFactory GraphicsConfigurationFactory.registerFactory(..)}.</li>
-  </ul><br>
-  This protocol <i>does not</i> describe how to <i>create</i> native windows, but how to <i>bind</i> a native surface to an implementation of 
-  and window to an implementation of {@link javax.media.nativewindow.NativeSurface NativeSurface}.<br>
-  {@link javax.media.nativewindow.NativeWindow NativeWindow} specializes the NativeSurface.<br>
-  However, an implementation of this protocol (e.g. {@link com.jogamp.newt}) may support the creation.<br>
+    <li> The specialisation of the abstract class {@link javax.media.nativewindow.GraphicsConfigurationFactory GraphicsConfigurationFactory}
+         <p>shall be registered with {@link javax.media.nativewindow.GraphicsConfigurationFactory#registerFactory GraphicsConfigurationFactory.registerFactory(..)}.</p></li>
+  </ul>
+  <p>This protocol <i>does not</i> describe how to <i>create</i> native windows, but how to <i>bind</i> a native surface to an implementation of 
+  and window to an implementation of {@link javax.media.nativewindow.NativeSurface NativeSurface}.</p>
+  <p>{@link javax.media.nativewindow.NativeWindow NativeWindow} specializes the NativeSurface.</p>
+  <p>However, an implementation of this protocol (e.g. {@link com.jogamp.newt}) may support the creation.</p>
    
 <h3>Dependencies</h3>
   This binding has dependencies to the following:
   <ul>
-    <li> Either of the following Java implementations:<br/>
+    <li> Either of the following Java implementations:
     <ul>
-        <li> <a href="http://java.sun.com/j2se/1.5.0/docs/api/">Java SE 1.5 or later</a> </li>
-        <li> A mobile JavaVM with language 1.5 support, ie:
+        <li> <a href="http://docs.oracle.com/javase/6/docs/api/">Java SE 1.6 or later</a> </li>
+        <li> A mobile JavaVM with language 1.6 support, ie:
             <ul>
-                <li> <a href="http://developer.android.com/reference/packages.html">Dalvik API Level 7</a> </li>
+                <li> <a href="http://developer.android.com/reference/packages.html">Android API Level 9 (Version 2.3)</a> </li>
                 <li> <a href="http://jamvm.sourceforge.net/">JamVM</a> </li>
             </ul>
             with
             <ul>
-                <li> <a href="http://java.sun.com/products/foundation/">Foundation Profile 1.1.2 (JSR 219)</a> </li>
-                <li> <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/nio/package-summary.html"> Java 1.4 <i>java.nio</i> implementation</a> </li>
+                <li> <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/nio/package-summary.html"> Java 1.4 <i>java.nio</i> implementation</a> </li>
             </ul></li>
     </ul></li>
   </ul>
   <br>
 
 <h3>Package Structure</h3>
-  The packages defined by this specification include:<br/><br/>
+  The packages defined by this specification include:
 <ul>
-    <li>The <b>javax.media.nativewindow</b> package<br>
-      <br>
-  This package contains Java bindings for a native windowing system.<br>
-  Subsequent packages contain marker type classes, containing native characteristics of the windowing system.
-
-  <ul>
-    <li>The <b>javax.media.nativewindow.awt</b> package<br>
-      <br>
-  This sub package contains classes to cover the native characteristics of the AWT windowing system.</li>
+    <li>The <b>javax.media.nativewindow</b> package
+    <p>This package contains Java bindings for a native windowing system.</p>
+    <p>Subsequent packages contain marker type classes, containing native characteristics of the windowing system.</p>
+    <ul>
+        <li>The <b>javax.media.nativewindow.awt</b> package
+        <p>This sub package contains classes to cover the native characteristics of the AWT windowing system.</p></li>
 
-    <li>The <b>javax.media.nativewindow.x11</b> package<br>
-      <br>
-  This sub package contains classes to cover the native characteristics of the X11 windowing system.</li>
+        <li>The <b>javax.media.nativewindow.x11</b> package
+        <p>This sub package contains classes to cover the native characteristics of the X11 windowing system.</p></li>
 
-    <li>The <b>javax.media.nativewindow.windows</b> package<br>
-      <br>
-  This sub package contains classes to cover the native characteristics of the Windows windowing system.</li>
+        <li>The <b>javax.media.nativewindow.windows</b> package
+        <p>This sub package contains classes to cover the native characteristics of the Windows windowing system.</p></li>
 
-    <li>The <b>javax.media.nativewindow.macosx</b> package<br>
-      <br>
-  This sub package contains classes to cover the native characteristics of the MacOSX windowing system.</li>
+        <li>The <b>javax.media.nativewindow.macosx</b> package
+        <p>This sub package contains classes to cover the native characteristics of the MacOSX windowing system.</p></li>
 
-    <li>The <b>javax.media.nativewindow.egl</b> package<br>
-      <br>
-  This sub package contains classes to cover the native characteristics of the EGL/OpenKODE windowing system.</li>
+        <li>The <b>javax.media.nativewindow.egl</b> package
+        <p>This sub package contains classes to cover the native characteristics of the EGL/OpenKODE windowing system.</p></li>
   </ul></li>
 </ul>
 
 <h3>Factory Model</h3>
-Running on a platform with a supported windowing system, the factory model shall be used
-to instantiate a native window, see {@link javax.media.nativewindow.NativeWindowFactory NativeWindowFactory}.<br>
-The implementor has to specialize 
-All supported 
-Regardless of the knowledge of the underly
-<br>
+<p>Running on a platform with a supported windowing system, the factory model shall be used
+to instantiate a native window, see {@link javax.media.nativewindow.NativeWindowFactory NativeWindowFactory}.</p>
 
-<h3>Revision History<br>
-  </h3>
+<h3>Revision History</h3>
    
 <ul>
 <li> Early Draft Review, June 2009</li>
 <li> 2.0.0 Maintenance Release, February 2011</li>
+<li> 2.0.2 Major Release, July 18th 2013</li>
 </ul>
   <br>
   <br>
author	Sven Gothel <[email protected]>	2013-07-17 16:15:32 +0200
committer	Sven Gothel <[email protected]>	2013-07-17 16:15:32 +0200
commit	5dc0e8c2bfc686ccac0902ff09448cd2f3ad65b4 (patch)
tree	12bdf8b828e21e951a64f9d7a662e4cab0ab7ff3 /src/nativewindow/classes
parent	cc63dc207f0b9f7ca53cbe3bc975b03773a257df (diff)