JogAmp JVM/JNI Utilities

From eddf305ce33ec1da8f1bc94337e81927ac1bcbae Mon Sep 17 00:00:00 2001 From: Sven Gothel Date: Tue, 9 Nov 2010 08:06:28 +0100 Subject: Enhance API doc .. package description etc --- src/java/com/jogamp/common/jvm/package.html | 9 ++++ src/java/com/jogamp/common/nio/package.html | 9 ++++ src/java/com/jogamp/common/os/package.html | 9 ++++ src/java/com/jogamp/common/package.html | 9 ++++ src/java/com/jogamp/common/util/locks/package.html | 9 ++++ src/java/com/jogamp/common/util/package.html | 9 ++++ src/java/com/jogamp/gluegen/GlueGen.java | 50 ----------------- src/java/com/jogamp/gluegen/package.html | 62 ++++++++++++++++++++++ 8 files changed, 116 insertions(+), 50 deletions(-) create mode 100644 src/java/com/jogamp/common/jvm/package.html create mode 100644 src/java/com/jogamp/common/nio/package.html create mode 100644 src/java/com/jogamp/common/os/package.html create mode 100644 src/java/com/jogamp/common/package.html create mode 100644 src/java/com/jogamp/common/util/locks/package.html create mode 100644 src/java/com/jogamp/common/util/package.html create mode 100644 src/java/com/jogamp/gluegen/package.html (limited to 'src') 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 @@ + + + + JogAmp JVM/JNI Utilities + + +

JogAmp JVM/JNI Utilities

+ + 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 @@ + + + + JogAmp NIO Utilities + + +

JogAmp NIO Utilities

+ + 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 @@ + + + + JogAmp OS Utilities + + +

JogAmp OS Utilities

+ + 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 @@ + + + + JogAmp Common Code + + +

JogAmp Common Code

+ + 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 @@ + + + + JogAmp Concurrency Utilities + + +

JogAmp Concurrency Utilities

+ + 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 @@ + + + + JogAmp HashMap, Reflection, .. Utilities + + +

JogAmp HashMap, Reflection, .. Utilities

+ + 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.
- *

- *

GlueGen Data Type Mapping

- * Gluegen has build-in types (terminal symbols) for:
- *
- * - * - * - * - * - * - * - * - * - * - * - * - *

type	java	native-x32	native-x64	type	signed	origin - *
__int32	32bit	32bit	32bit	integer	signed or unsigned	windows
int32_t	32bit	32bit	32bit	integer	signed	stdint.h
wchar_t	32bit	32bit	32bit	integer	signed	stddef.h
uint32_t	32bit	32bit	32bit	integer	unsigned	stdint.h
__int64	64bit	64bit	64bit	integer	signed or unsigned	windows
int64_t	64bit	64bit	64bit	integer	signed	stdint.h
uint64_t	64bit	64bit	64bit	integer	unsigned	stdint.h
ptrdiff_t	64bit	32bit	64bit	integer	signed	stddef.h
intptr_t	64bit	32bit	64bit	integer	signed	stdint.h
size_t	64bit	32bit	64bit	integer	unsigned	stddef.h
uintptr_t	64bit	32bit	64bit	integer	unsigned	stdint.h

- *

GlueGen Platform Header Files

- * GlueGen provides convenient platform headers,
- * which can be included in your C header files for native compilation and GlueGen code generation.
- *
- * Example:
- *

-   #include <gluegen_stdint.h>
-   #include <gluegen_stddef.h>
- 
-   uint64_t test64;
-   size_t size1;
-   ptrdiff_t ptr1;
- *

- *
- * To compile this file you have to include the following folder to your compilers system includes, ie -I:
- *

- *   gluegen/make/stub_includes/platform
- *

- *
- * To generate code for this file you have to include the following folder to your GlueGen includeRefid element:
- *

- *   gluegen/make/stub_includes/gluegen
- *

- *

GlueGen Pre-Defined Macros

- * To identity a GlueGen code generation run, GlueGen defines the following macros:
- *

-     #define __GLUEGEN__ 2
- *

- *

*/ - 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 @@ + + + + GlueGen Code Generator + + +

JogAmp GlueGen Code Generator

GlueGen Data Type Mapping

+ Gluegen has build-in types (terminal symbols) for:
+
+ + + + + + + + + + + + +

type	java	native-x32	native-x64	type	signed	origin +
__int32	32bit	32bit	32bit	integer	signed or unsigned	windows
int32_t	32bit	32bit	32bit	integer	signed	stdint.h
wchar_t	32bit	32bit	32bit	integer	signed	stddef.h
uint32_t	32bit	32bit	32bit	integer	unsigned	stdint.h
__int64	64bit	64bit	64bit	integer	signed or unsigned	windows
int64_t	64bit	64bit	64bit	integer	signed	stdint.h
uint64_t	64bit	64bit	64bit	integer	unsigned	stdint.h
ptrdiff_t	64bit	32bit	64bit	integer	signed	stddef.h
intptr_t	64bit	32bit	64bit	integer	signed	stdint.h
size_t	64bit	32bit	64bit	integer	unsigned	stddef.h
uintptr_t	64bit	32bit	64bit	integer	unsigned	stdint.h

GlueGen Platform Header Files

+ GlueGen provides convenient platform headers,
+ which can be included in your C header files for native compilation and GlueGen code generation.
+
+ Example:
+

+   #include <gluegen_stdint.h>
+   #include <gluegen_stddef.h>
+ 
+   uint64_t test64;
+   size_t size1;
+   ptrdiff_t ptr1;
+

+
+ To compile this file you have to include the following folder to your compilers system includes, ie -I:
+

+    gluegen/make/stub_includes/platform
+

+
+ To generate code for this file you have to include the following folder to your GlueGen includeRefid element:
+

+    gluegen/make/stub_includes/gluegen
+

GlueGen Pre-Defined Macros

+ To identity a GlueGen code generation run, GlueGen defines the following macros:
+

+     #define __GLUEGEN__ 2
+

+
+
+ + -- cgit v1.2.3