summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2010-11-09 08:06:28 +0100
committerSven Gothel <[email protected]>2010-11-09 08:06:28 +0100
commiteddf305ce33ec1da8f1bc94337e81927ac1bcbae (patch)
tree6f85a4f20d41c6ca3760696c218cbd8739e97f44 /src
parent37dea2b98c67cb6b32baf88022e75cfc3b71879e (diff)
Enhance API doc .. package description etc
Diffstat (limited to 'src')
-rw-r--r--src/java/com/jogamp/common/jvm/package.html9
-rw-r--r--src/java/com/jogamp/common/nio/package.html9
-rw-r--r--src/java/com/jogamp/common/os/package.html9
-rw-r--r--src/java/com/jogamp/common/package.html9
-rw-r--r--src/java/com/jogamp/common/util/locks/package.html9
-rw-r--r--src/java/com/jogamp/common/util/package.html9
-rw-r--r--src/java/com/jogamp/gluegen/GlueGen.java50
-rw-r--r--src/java/com/jogamp/gluegen/package.html62
8 files changed, 116 insertions, 50 deletions
diff --git a/src/java/com/jogamp/common/jvm/package.html b/src/java/com/jogamp/common/jvm/package.html
new file mode 100644
index 0000000..8cf3ecc
--- /dev/null
+++ b/src/java/com/jogamp/common/jvm/package.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <title>JogAmp JVM/JNI Utilities</title>
+</head>
+ <body>
+<h2><i>JogAmp</i> JVM/JNI Utilities</h2>
+</body>
+</html>
diff --git a/src/java/com/jogamp/common/nio/package.html b/src/java/com/jogamp/common/nio/package.html
new file mode 100644
index 0000000..4f79ca4
--- /dev/null
+++ b/src/java/com/jogamp/common/nio/package.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <title>JogAmp NIO Utilities</title>
+</head>
+ <body>
+<h2><i>JogAmp</i> NIO Utilities</h2>
+</body>
+</html>
diff --git a/src/java/com/jogamp/common/os/package.html b/src/java/com/jogamp/common/os/package.html
new file mode 100644
index 0000000..5bcb41d
--- /dev/null
+++ b/src/java/com/jogamp/common/os/package.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <title>JogAmp OS Utilities</title>
+</head>
+ <body>
+<h2><i>JogAmp</i> OS Utilities</h2>
+</body>
+</html>
diff --git a/src/java/com/jogamp/common/package.html b/src/java/com/jogamp/common/package.html
new file mode 100644
index 0000000..a06937f
--- /dev/null
+++ b/src/java/com/jogamp/common/package.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <title>JogAmp Common Code</title>
+</head>
+ <body>
+<h2><i>JogAmp</i> Common Code</h2>
+</body>
+</html>
diff --git a/src/java/com/jogamp/common/util/locks/package.html b/src/java/com/jogamp/common/util/locks/package.html
new file mode 100644
index 0000000..bf68beb
--- /dev/null
+++ b/src/java/com/jogamp/common/util/locks/package.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <title>JogAmp Concurrency Utilities</title>
+</head>
+ <body>
+<h2><i>JogAmp</i> Concurrency Utilities</h4>
+</body>
+</html>
diff --git a/src/java/com/jogamp/common/util/package.html b/src/java/com/jogamp/common/util/package.html
new file mode 100644
index 0000000..c9be142
--- /dev/null
+++ b/src/java/com/jogamp/common/util/package.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <title>JogAmp HashMap, Reflection, .. Utilities</title>
+</head>
+ <body>
+<h2><i>JogAmp</i> HashMap, Reflection, .. Utilities</h2>
+</body>
+</html>
diff --git a/src/java/com/jogamp/gluegen/GlueGen.java b/src/java/com/jogamp/gluegen/GlueGen.java
index e88538e..7a0ed3c 100644
--- a/src/java/com/jogamp/gluegen/GlueGen.java
+++ b/src/java/com/jogamp/gluegen/GlueGen.java
@@ -51,57 +51,7 @@ import static java.lang.System.*;
/**
* Glue code generator for C functions and data structures.<br>
- * <p>
- * <h4>GlueGen Data Type Mapping</h4>
- * Gluegen has build-in types (terminal symbols) for:<br>
- * <br>
- * <table border="1">
- * <tr><th>type</th> <th>java</th> <th>native-x32</th><th>native-x64</th><th>type</th> <th>signed</th> <th>origin</th</tr>
- * <tr><th>__int32</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>signed or unsigned</th><th>windows</th></tr>
- * <tr><th>int32_t</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>signed</th> <th>stdint.h</th></tr>
- * <tr><th>wchar_t</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>signed</th> <th>stddef.h</th></tr>
- * <tr><th>uint32_t</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>unsigned</th> <th>stdint.h</th></tr>
- * <tr><th>__int64</th> <th>64bit</th><th>64bit</th> <th>64bit</th> <th>integer</th><th>signed or unsigned</th><th>windows</th></tr>
- * <tr><th>int64_t</th> <th>64bit</th><th>64bit</th> <th>64bit</th> <th>integer</th><th>signed</th> <th>stdint.h</th></tr>
- * <tr><th>uint64_t</th> <th>64bit</th><th>64bit</th> <th>64bit</th> <th>integer</th><th>unsigned</th> <th>stdint.h</th></tr>
- * <tr><th>ptrdiff_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>signed</th> <th>stddef.h</th></tr>
- * <tr><th>intptr_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>signed</th> <th>stdint.h</th></tr>
- * <tr><th>size_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>unsigned</th> <th>stddef.h</th></tr>
- * <tr><th>uintptr_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>unsigned</th> <th>stdint.h</th></tr>
- * </table></p>
- * <p>
- * <h4>GlueGen Platform Header Files</h4>
- * GlueGen provides convenient platform headers,<br>
- * which can be included in your C header files for native compilation and GlueGen code generation.<br>
- * <br>
- * Example:<br>
- * <pre>
- #include &lt;gluegen_stdint.h&gt;
- #include &lt;gluegen_stddef.h&gt;
-
- uint64_t test64;
- size_t size1;
- ptrdiff_t ptr1;
- * </pre>
- * <br>
- * To compile this file you have to include the following folder to your compilers system includes, ie <code>-I</code>:<br>
- * <pre>
- * gluegen/make/stub_includes/platform
- * </pre>
- * <br>
- * To generate code for this file you have to include the following folder to your GlueGen <code>includeRefid</code> element:<br>
- * <pre>
- * gluegen/make/stub_includes/gluegen
- * </pre></p>
- * <p>
- * <h4>GlueGen Pre-Defined Macros</h4>
- * To identity a GlueGen code generation run, GlueGen defines the following macros:<br>
- * <pre>
- #define __GLUEGEN__ 2
- * </pre>
- * </p>
*/
-
public class GlueGen implements GlueEmitterControls {
static{
diff --git a/src/java/com/jogamp/gluegen/package.html b/src/java/com/jogamp/gluegen/package.html
new file mode 100644
index 0000000..68f4eb9
--- /dev/null
+++ b/src/java/com/jogamp/gluegen/package.html
@@ -0,0 +1,62 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <title>GlueGen Code Generator</title>
+</head>
+ <body>
+<h2><i>JogAmp GlueGen</i> Code Generator</h2>
+ <p>
+ <h4>GlueGen Data Type Mapping</h4>
+ Gluegen has build-in types (terminal symbols) for:<br>
+ <br>
+ <table border="1">
+ <tr><th>type</th> <th>java</th> <th>native-x32</th><th>native-x64</th><th>type</th> <th>signed</th> <th>origin</th</tr>
+ <tr><th>__int32</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>signed or unsigned</th><th>windows</th></tr>
+ <tr><th>int32_t</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>signed</th> <th>stdint.h</th></tr>
+ <tr><th>wchar_t</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>signed</th> <th>stddef.h</th></tr>
+ <tr><th>uint32_t</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>unsigned</th> <th>stdint.h</th></tr>
+ <tr><th>__int64</th> <th>64bit</th><th>64bit</th> <th>64bit</th> <th>integer</th><th>signed or unsigned</th><th>windows</th></tr>
+ <tr><th>int64_t</th> <th>64bit</th><th>64bit</th> <th>64bit</th> <th>integer</th><th>signed</th> <th>stdint.h</th></tr>
+ <tr><th>uint64_t</th> <th>64bit</th><th>64bit</th> <th>64bit</th> <th>integer</th><th>unsigned</th> <th>stdint.h</th></tr>
+ <tr><th>ptrdiff_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>signed</th> <th>stddef.h</th></tr>
+ <tr><th>intptr_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>signed</th> <th>stdint.h</th></tr>
+ <tr><th>size_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>unsigned</th> <th>stddef.h</th></tr>
+ <tr><th>uintptr_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>unsigned</th> <th>stdint.h</th></tr>
+ </table>
+ </p>
+ <p>
+ <h4>GlueGen Platform Header Files</h4>
+ GlueGen provides convenient platform headers,<br>
+ which can be included in your C header files for native compilation and GlueGen code generation.<br>
+ <br>
+ Example:<br>
+ <pre>
+ #include &lt;gluegen_stdint.h&gt;
+ #include &lt;gluegen_stddef.h&gt;
+
+ uint64_t test64;
+ size_t size1;
+ ptrdiff_t ptr1;
+ </pre>
+ <br>
+ To compile this file you have to include the following folder to your compilers system includes, ie <code>-I</code>:<br>
+ <pre>
+ gluegen/make/stub_includes/platform
+ </pre>
+ <br>
+ To generate code for this file you have to include the following folder to your GlueGen <code>includeRefid</code> element:<br>
+ <pre>
+ gluegen/make/stub_includes/gluegen
+ </pre>
+ </p>
+ <p>
+ <h4>GlueGen Pre-Defined Macros</h4>
+ To identity a GlueGen code generation run, GlueGen defines the following macros:<br>
+ <pre>
+ #define __GLUEGEN__ 2
+ </pre>
+ </p>
+ <br>
+ <br>
+</body>
+</html>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-30 07:48:39 +0000