diff options
-rw-r--r-- | build.xml | 9 | ||||
-rw-r--r-- | nbproject/project.properties | 2 | ||||
-rw-r--r-- | resources/cl-buffer-if.cfg | 2 | ||||
-rw-r--r-- | resources/cl-context-if.cfg | 2 | ||||
-rw-r--r-- | resources/cl-device-if.cfg | 2 | ||||
-rw-r--r-- | resources/cl-event-if.cfg | 2 | ||||
-rw-r--r-- | resources/cl-image-if.cfg | 2 | ||||
-rw-r--r-- | resources/cl-kernel-if.cfg | 2 | ||||
-rw-r--r-- | resources/cl-mem-if.cfg | 2 | ||||
-rw-r--r-- | resources/cl-platform-if.cfg | 2 | ||||
-rw-r--r-- | resources/cl-program-if.cfg | 2 | ||||
-rw-r--r-- | resources/cl-queue-if.cfg | 2 | ||||
-rw-r--r-- | resources/cl-sampler-if.cfg | 2 | ||||
-rw-r--r-- | src/com/jogamp/opencl/gl/package.html | 7 | ||||
-rw-r--r-- | src/com/jogamp/opencl/llb/gl/package.html | 7 | ||||
-rw-r--r-- | src/com/jogamp/opencl/llb/impl/CLImpl.java | 24 | ||||
-rw-r--r-- | src/com/jogamp/opencl/llb/package.html | 7 | ||||
-rw-r--r-- | src/com/jogamp/opencl/package.html | 7 | ||||
-rw-r--r-- | src/com/jogamp/opencl/spi/package.html | 7 | ||||
-rw-r--r-- | src/com/jogamp/opencl/util/concurrent/package.html | 7 | ||||
-rw-r--r-- | src/com/jogamp/opencl/util/package.html | 7 | ||||
-rw-r--r-- | src/overview.html | 6 |
22 files changed, 86 insertions, 26 deletions
@@ -525,12 +525,18 @@ <fileset dir="${jogl.root}/build/javadoc"/> </copy> + <copy file="${basedir}/src/com/jogamp/opencl/llb/package.html" + todir="${basedir}/gensrc/java/com/jogamp/opencl/llb" overwrite="true"/> + + <copy file="${basedir}/src/com/jogamp/opencl/llb/gl/package.html" + todir="${basedir}/gensrc/java/com/jogamp/opencl/llb/gl" overwrite="true"/> + <javadoc author="${javadoc.author}" charset="UTF-8" destdir="${dist.javadoc.dir}" docencoding="UTF-8" encoding="${javadoc.encoding.used}" failonerror="true" noindex="${javadoc.noindex}" nonavbar="${javadoc.nonavbar}" notree="${javadoc.notree}" private="${javadoc.private}" source="${javac.source}" splitindex="${javadoc.splitindex}" use="${javadoc.use}" useexternalfile="true" version="${javadoc.version}" - windowtitle="${javadoc.windowtitle}"> + windowtitle="${javadoc.windowtitle}" overview="${basedir}/src/overview.html"> <arg line="${javadoc.additionalparam} -J-Dnativetaglet.mapping=${basedir}/resources/native-taglet.properties"/> <taglet name="net.highteq.nativetaglet.NativeTaglet" path="${gluegen.root}/${rootrel.build}/gluegen.jar"/> @@ -555,7 +561,6 @@ <include name="**/*.java"/> </fileset> - <excludepackage name="com.jogamp.opencl.impl"/> </javadoc> </target> diff --git a/nbproject/project.properties b/nbproject/project.properties index 7de4c49a..0214d3dd 100644 --- a/nbproject/project.properties +++ b/nbproject/project.properties @@ -10,7 +10,7 @@ javac.processorpath=\ ${javac.classpath} application.title=JOCL application.vendor=Michael Bien -build.classes.excludes=**/*.java,**/*.jtemplate,**/*.form,**/*.c +build.classes.excludes=**/*.java,**/*.jtemplate,**/*.form,**/*.c,**/*.html # This directory is removed when the project is cleaned: build.dir=${rootrel.build} build.classes.dir=${build.dir}/classes diff --git a/resources/cl-buffer-if.cfg b/resources/cl-buffer-if.cfg index 95d5f572..ad670250 100644 --- a/resources/cl-buffer-if.cfg +++ b/resources/cl-buffer-if.cfg @@ -3,7 +3,7 @@ Include cl-common.cfg Style InterfaceOnly ClassJavadoc CLBuffer /** -ClassJavadoc CLBuffer * Java bindings to OpenCL, the Open Computing Language. +ClassJavadoc CLBuffer * Java bindings to OpenCL buffers. ClassJavadoc CLBuffer * @author Michael Bien ClassJavadoc CLBuffer */ JavaClass CLBuffer diff --git a/resources/cl-context-if.cfg b/resources/cl-context-if.cfg index ce7fba2d..8a12af7d 100644 --- a/resources/cl-context-if.cfg +++ b/resources/cl-context-if.cfg @@ -6,7 +6,7 @@ Import com.jogamp.opencl.llb.impl.CLImageFormatImpl Import com.jogamp.opencl.CLErrorHandler ClassJavadoc CLContext /** -ClassJavadoc CLContext * Java bindings to OpenCL, the Open Computing Language. +ClassJavadoc CLContext * Java bindings to OpenCL contexts. ClassJavadoc CLContext * @author Michael Bien ClassJavadoc CLContext */ JavaClass CLContext diff --git a/resources/cl-device-if.cfg b/resources/cl-device-if.cfg index fe09a343..797d9285 100644 --- a/resources/cl-device-if.cfg +++ b/resources/cl-device-if.cfg @@ -3,7 +3,7 @@ Include cl-common.cfg Style InterfaceOnly ClassJavadoc CLDevice /** -ClassJavadoc CLDevice * Java bindings to OpenCL, the Open Computing Language. +ClassJavadoc CLDevice * Java bindings to OpenCL devices. ClassJavadoc CLDevice * @author Michael Bien ClassJavadoc CLDevice */ JavaClass CLDevice diff --git a/resources/cl-event-if.cfg b/resources/cl-event-if.cfg index 5d24302f..8e0759b1 100644 --- a/resources/cl-event-if.cfg +++ b/resources/cl-event-if.cfg @@ -5,7 +5,7 @@ Style InterfaceOnly import com.jogamp.opencl.llb.impl.CLEventCallback ClassJavadoc CLEvent /** -ClassJavadoc CLEvent * Java bindings to OpenCL, the Open Computing Language. +ClassJavadoc CLEvent * Java bindings to OpenCL events. ClassJavadoc CLEvent * @author Michael Bien ClassJavadoc CLEvent */ JavaClass CLEvent diff --git a/resources/cl-image-if.cfg b/resources/cl-image-if.cfg index 39814f23..e94959ab 100644 --- a/resources/cl-image-if.cfg +++ b/resources/cl-image-if.cfg @@ -5,7 +5,7 @@ Style InterfaceOnly Import com.jogamp.opencl.llb.impl.CLImageFormatImpl ClassJavadoc CLImage /** -ClassJavadoc CLImage * Java bindings to OpenCL, the Open Computing Language. +ClassJavadoc CLImage * Java bindings to OpenCL images. ClassJavadoc CLImage * @author Michael Bien ClassJavadoc CLImage */ JavaClass CLImage diff --git a/resources/cl-kernel-if.cfg b/resources/cl-kernel-if.cfg index 930160cb..56c70138 100644 --- a/resources/cl-kernel-if.cfg +++ b/resources/cl-kernel-if.cfg @@ -3,7 +3,7 @@ Include cl-common.cfg Style InterfaceOnly ClassJavadoc CLKernel /** -ClassJavadoc CLKernel * Java bindings to OpenCL, the Open Computing Language. +ClassJavadoc CLKernel * Java bindings to OpenCL kernels. ClassJavadoc CLKernel * @author Michael Bien ClassJavadoc CLKernel */ JavaClass CLKernel diff --git a/resources/cl-mem-if.cfg b/resources/cl-mem-if.cfg index 6efc344d..12e3c9cc 100644 --- a/resources/cl-mem-if.cfg +++ b/resources/cl-mem-if.cfg @@ -5,7 +5,7 @@ Style InterfaceOnly import com.jogamp.opencl.llb.impl.CLMemObjectDestructorCallback ClassJavadoc CLMemObj /** -ClassJavadoc CLMemObj * Java bindings to OpenCL, the Open Computing Language. +ClassJavadoc CLMemObj * Java bindings to OpenCL memory objects. ClassJavadoc CLMemObj * @author Michael Bien ClassJavadoc CLMemObj */ JavaClass CLMemObj diff --git a/resources/cl-platform-if.cfg b/resources/cl-platform-if.cfg index a6a3e763..72330cce 100644 --- a/resources/cl-platform-if.cfg +++ b/resources/cl-platform-if.cfg @@ -3,7 +3,7 @@ Include cl-common.cfg Style InterfaceOnly ClassJavadoc CLPlatform /** -ClassJavadoc CLPlatform * Java bindings to OpenCL, the Open Computing Language. +ClassJavadoc CLPlatform * Java bindings to OpenCL platforms. ClassJavadoc CLPlatform * @author Michael Bien ClassJavadoc CLPlatform */ JavaClass CLPlatform diff --git a/resources/cl-program-if.cfg b/resources/cl-program-if.cfg index 109430ca..16bdc32d 100644 --- a/resources/cl-program-if.cfg +++ b/resources/cl-program-if.cfg @@ -5,7 +5,7 @@ Style InterfaceOnly Import com.jogamp.opencl.llb.impl.BuildProgramCallback ClassJavadoc CLProgram /** -ClassJavadoc CLProgram * Java bindings to OpenCL, the Open Computing Language. +ClassJavadoc CLProgram * Java bindings to OpenCL programs. ClassJavadoc CLProgram * @author Michael Bien ClassJavadoc CLProgram */ JavaClass CLProgram diff --git a/resources/cl-queue-if.cfg b/resources/cl-queue-if.cfg index 5576709d..764284b6 100644 --- a/resources/cl-queue-if.cfg +++ b/resources/cl-queue-if.cfg @@ -3,7 +3,7 @@ Include cl-common.cfg Style InterfaceOnly ClassJavadoc CLCommandQueue /** -ClassJavadoc CLCommandQueue * Java bindings to OpenCL, the Open Computing Language. +ClassJavadoc CLCommandQueue * Java bindings to OpenCL command queues. ClassJavadoc CLCommandQueue * @author Michael Bien ClassJavadoc CLCommandQueue */ JavaClass CLCommandQueue diff --git a/resources/cl-sampler-if.cfg b/resources/cl-sampler-if.cfg index 3b705c59..b13d0d6f 100644 --- a/resources/cl-sampler-if.cfg +++ b/resources/cl-sampler-if.cfg @@ -3,7 +3,7 @@ Include cl-common.cfg Style InterfaceOnly ClassJavadoc CLSampler /** -ClassJavadoc CLSampler * Java bindings to OpenCL, the Open Computing Language. +ClassJavadoc CLSampler * Java bindings to OpenCL sampler objects. ClassJavadoc CLSampler * @author Michael Bien ClassJavadoc CLSampler */ JavaClass CLSampler diff --git a/src/com/jogamp/opencl/gl/package.html b/src/com/jogamp/opencl/gl/package.html new file mode 100644 index 00000000..24ad0c2e --- /dev/null +++ b/src/com/jogamp/opencl/gl/package.html @@ -0,0 +1,7 @@ +<!DOCTYPE html> +<html> + <head></head> + <body> + High level java bindings, OpenCL-OpenGL interoperability. + </body> +</html> diff --git a/src/com/jogamp/opencl/llb/gl/package.html b/src/com/jogamp/opencl/llb/gl/package.html new file mode 100644 index 00000000..47cec148 --- /dev/null +++ b/src/com/jogamp/opencl/llb/gl/package.html @@ -0,0 +1,7 @@ +<!DOCTYPE html> +<html> + <head></head> + <body> + Low level java bindings, OpenCL-OpenGL interoperability. + </body> +</html> diff --git a/src/com/jogamp/opencl/llb/impl/CLImpl.java b/src/com/jogamp/opencl/llb/impl/CLImpl.java index 5de3126d..d4a1672b 100644 --- a/src/com/jogamp/opencl/llb/impl/CLImpl.java +++ b/src/com/jogamp/opencl/llb/impl/CLImpl.java @@ -181,12 +181,12 @@ public class CLImpl extends CLAbstractImpl { /** Interface to C language function: <br> <code> void * {@native clEnqueueMapImage}(cl_command_queue command_queue, cl_mem image, uint32_t blocking_map, uint64_t map_flags, const size_t * , const size_t * , size_t * image_row_pitch, size_t * image_slice_pitch, uint32_t num_events_in_wait_list, cl_event * event_wait_list, cl_event * event, int32_t * errcode_ret); </code> - @param origin a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} - @param range a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} - @param image_row_pitch a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} - @param image_slice_pitch a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} - @param event_wait_list a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} - @param event a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} + @param origin a direct {@link com.jogamp.common.nio.NativeSizeBuffer} + @param range a direct {@link com.jogamp.common.nio.NativeSizeBuffer} + @param image_row_pitch a direct {@link com.jogamp.common.nio.NativeSizeBuffer} + @param image_slice_pitch a direct {@link com.jogamp.common.nio.NativeSizeBuffer} + @param event_wait_list a direct {@link com.jogamp.common.nio.NativeSizeBuffer} + @param event a direct {@link com.jogamp.common.nio.NativeSizeBuffer} @param errcode_ret a direct {@link java.nio.IntBuffer} */ @Override public ByteBuffer clEnqueueMapImage(long command_queue, long image, int blocking_map, long map_flags, @@ -242,12 +242,12 @@ public class CLImpl extends CLAbstractImpl { } /** Entry point to C language function: <code> void * {@native clEnqueueMapImage}(cl_command_queue command_queue, cl_mem image, uint32_t blocking_map, uint64_t map_flags, const size_t * , const size_t * , size_t * image_row_pitch, size_t * image_slice_pitch, uint32_t num_events_in_wait_list, cl_event * event_wait_list, cl_event * event, int32_t * errcode_ret); </code> - @param origin a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} - @param range a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} - @param image_row_pitch a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} - @param image_slice_pitch a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} - @param event_wait_list a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} - @param event a direct {@link com.jogamp.gluegen.common.nio.NativeSizeBuffer} + @param origin a direct {@link com.jogamp.common.nio.NativeSizeBuffer} + @param range a direct {@link com.jogamp.common.nio.NativeSizeBuffer} + @param image_row_pitch a direct {@link com.jogamp.common.nio.NativeSizeBuffer} + @param image_slice_pitch a direct {@link com.jogamp.common.nio.NativeSizeBuffer} + @param event_wait_list a direct {@link com.jogamp.common.nio.NativeSizeBuffer} + @param event a direct {@link com.jogamp.common.nio.NativeSizeBuffer} @param errcode_ret a direct {@link java.nio.IntBuffer} */ private native ByteBuffer clEnqueueMapImage0(long command_queue, long image, int blocking_map, long map_flags, Object origin, int origin_byte_offset, Object range, int range_byte_offset, Object image_row_pitch, diff --git a/src/com/jogamp/opencl/llb/package.html b/src/com/jogamp/opencl/llb/package.html new file mode 100644 index 00000000..b68c4de7 --- /dev/null +++ b/src/com/jogamp/opencl/llb/package.html @@ -0,0 +1,7 @@ +<!DOCTYPE html> +<html> + <head></head> + <body> + Low level java bindings to OpenCL. + </body> +</html> diff --git a/src/com/jogamp/opencl/package.html b/src/com/jogamp/opencl/package.html new file mode 100644 index 00000000..c7cc0a33 --- /dev/null +++ b/src/com/jogamp/opencl/package.html @@ -0,0 +1,7 @@ +<!DOCTYPE html> +<html> + <head></head> + <body> + High level java bindings to OpenCL. + </body> +</html> diff --git a/src/com/jogamp/opencl/spi/package.html b/src/com/jogamp/opencl/spi/package.html new file mode 100644 index 00000000..436d5d2b --- /dev/null +++ b/src/com/jogamp/opencl/spi/package.html @@ -0,0 +1,7 @@ +<!DOCTYPE html> +<html> + <head></head> + <body> + SPI for alternative binding implementations. + </body> +</html> diff --git a/src/com/jogamp/opencl/util/concurrent/package.html b/src/com/jogamp/opencl/util/concurrent/package.html new file mode 100644 index 00000000..8b9dc9eb --- /dev/null +++ b/src/com/jogamp/opencl/util/concurrent/package.html @@ -0,0 +1,7 @@ +<!DOCTYPE html> +<html> + <head></head> + <body> + OpenCL multi device concurrency utilities. + </body> +</html> diff --git a/src/com/jogamp/opencl/util/package.html b/src/com/jogamp/opencl/util/package.html new file mode 100644 index 00000000..1408c02b --- /dev/null +++ b/src/com/jogamp/opencl/util/package.html @@ -0,0 +1,7 @@ +<!DOCTYPE html> +<html> + <head></head> + <body> + OpenCL utilities. + </body> +</html> diff --git a/src/overview.html b/src/overview.html new file mode 100644 index 00000000..468247ef --- /dev/null +++ b/src/overview.html @@ -0,0 +1,6 @@ +<!DOCTYPE html> +<html> + <body> + Java bindings to OpenCL (JOCL). + </body> +</html> |