diff options
author | Michael Bien <[email protected]> | 2009-11-22 23:06:41 +0100 |
---|---|---|
committer | Michael Bien <[email protected]> | 2009-11-22 23:06:41 +0100 |
commit | bee7d042a78b76afee1789bd48ab3e67c9a3fe8d (patch) | |
tree | a7578f07588acaa26da1fb4acad71fa8d9961687 /resources | |
parent | a23d5e45b8112ffc7ba02bc564ace6ed6c0414b9 (diff) |
generated javadoc links now to the official OpenCL doc (http://www.khronos.org/opencl/sdk/1.0/docs/man/xhtml/).
every generated method contains now a link to the specific OpenCL man page of the native OpenCL function.
Diffstat (limited to 'resources')
-rw-r--r-- | resources/cl-common.cfg | 2 | ||||
-rw-r--r-- | resources/clgl-if.cfg | 2 | ||||
-rw-r--r-- | resources/createTagletProps.sh | 9 | ||||
-rw-r--r-- | resources/native-taglet.properties | 114 |
4 files changed, 126 insertions, 1 deletions
diff --git a/resources/cl-common.cfg b/resources/cl-common.cfg index 828cecf1..72f78fb9 100644 --- a/resources/cl-common.cfg +++ b/resources/cl-common.cfg @@ -38,3 +38,5 @@ ClassJavadoc CLImageFormat * Struct accessor for cl_image_format. ClassJavadoc CLImageFormat * @author Michael Bien ClassJavadoc CLImageFormat */ +# Pick up on-line OpenCL doc and link it with the javadoc +TagNativeBinding true
\ No newline at end of file diff --git a/resources/clgl-if.cfg b/resources/clgl-if.cfg index d21e8072..44275556 100644 --- a/resources/clgl-if.cfg +++ b/resources/clgl-if.cfg @@ -5,7 +5,7 @@ Style InterfaceOnly ClassJavadoc CLGLI /** ClassJavadoc CLGLI * Java bindings to OpenCL, the Open Computing Language. ClassJavadoc CLGLI * OpenGL - OpenCL interoperability. -ClassJavadoc CLGLI * @autor Michael Bien +ClassJavadoc CLGLI * @author Michael Bien ClassJavadoc CLGLI */ JavaClass CLGLI diff --git a/resources/createTagletProps.sh b/resources/createTagletProps.sh new file mode 100644 index 00000000..537f61fe --- /dev/null +++ b/resources/createTagletProps.sh @@ -0,0 +1,9 @@ +#download index +wget http://www.khronos.org/opencl/sdk/1.0/docs/man/xhtml/Opencl_tofc.html; +#find links to cl* function doc +grep -E .+\<a\ href=\"cl[A-Z][^\"]+\"[^\>]+\>cl[A-Z][a-Z]+\</a\>.+ ./Opencl_tofc.html > links; +#add doc root to properties file +echo nativetaglet.baseUrl=http://www.khronos.org/opencl/sdk/1.0/docs/man/xhtml/ > native-taglet.properties; +#add all links as properties to file and cleanup +sed -r 's/\s+<li><a href="([a-Z.]+)"[^>]+>([a-Z]+)<\/a><\/li>/\2=\1/' links >> native-taglet.properties; +rm ./Opencl_tofc.html ./links diff --git a/resources/native-taglet.properties b/resources/native-taglet.properties new file mode 100644 index 00000000..d5e64e9d --- /dev/null +++ b/resources/native-taglet.properties @@ -0,0 +1,114 @@ +nativetaglet.baseUrl=http://www.khronos.org/opencl/sdk/1.0/docs/man/xhtml/ +clCreateCommandQueue=clCreateCommandQueue.html
+clCreateContext=clCreateContext.html
+clCreateContextFromType=clCreateContextFromType.html
+clCreateFromGLBuffer=clCreateFromGLBuffer.html
+clCreateFromGLRenderbuffer=clCreateFromGLRenderbuffer.html
+clCreateKernelsInProgram=clCreateKernelsInProgram.html
+clCreateProgramWithBinary=clCreateProgramWithBinary.html
+clCreateProgramWithSource=clCreateProgramWithSource.html
+clCreateSampler=clCreateSampler.html
+clEnqueueAcquireGLObjects=clEnqueueAcquireGLObjects.html
+clEnqueueBarrier=clEnqueueBarrier.html
+clEnqueueMarker=clEnqueueMarker.html
+clEnqueueNativeKernel=clEnqueueNativeKernel.html
+clEnqueueReleaseGLObjects=clEnqueueReleaseGLObjects.html
+clEnqueueUnmapMemObject=clEnqueueUnmapMemObject.html
+clEnqueueWaitForEvents=clEnqueueWaitForEvents.html
+clEnqueueWriteImage=clEnqueueWriteImage.html
+clFinish=clFinish.html
+clFlush=clFlush.html
+clGetCommandQueueInfo=clGetCommandQueueInfo.html
+clGetContextInfo=clGetContextInfo.html
+clGetDeviceIDs=clGetDeviceIDs.html
+clGetDeviceInfo=clGetDeviceInfo.html
+clGetEventProfilingInfo=clGetEventProfilingInfo.html
+clGetExtensionFunctionAddress=clGetExtensionFunctionAddress.html
+clGetGLObjectInfo=clGetGLObjectInfo.html
+clGetGLTextureInfo=clGetGLTextureInfo.html
+clGetImageInfo=clGetImageInfo.html
+clGetKernelWorkGroupInfo=clGetKernelWorkGroupInfo.html
+clGetMemObjectInfo=clGetMemObjectInfo.html
+clGetPlatformIDs=clGetPlatformIDs.html
+clGetPlatformInfo=clGetPlatformInfo.html
+clGetProgramBuildInfo=clGetProgramBuildInfo.html
+clReleaseEvent=clReleaseEvent.html
+clReleaseKernel=clReleaseKernel.html
+clReleaseProgram=clReleaseProgram.html
+clReleaseSampler=clReleaseSampler.html
+clRetainContext=clRetainContext.html
+clRetainEvent=clRetainEvent.html
+clRetainMemObject=clRetainMemObject.html
+clRetainProgram=clRetainProgram.html
+clRetainSampler=clRetainSampler.html
+clSetCommandQueueProperty=clSetCommandQueueProperty.html
+clSetKernelArg=clSetKernelArg.html
+clUnloadCompiler=clUnloadCompiler.html
+clWaitForEvents=clWaitForEvents.html
+clGetPlatformIDs=clGetPlatformIDs.html
+clGetPlatformInfo=clGetPlatformInfo.html
+clGetDeviceIDs=clGetDeviceIDs.html
+clGetDeviceInfo=clGetDeviceInfo.html
+clCreateContext=clCreateContext.html
+clRetainContext=clRetainContext.html
+clReleaseContext=clReleaseContext.html
+clGetContextInfo=clGetContextInfo.html
+clCreateCommandQueue=clCreateCommandQueue.html
+clRetainCommandQueue=clRetainCommandQueue.html
+clReleaseCommandQueue=clReleaseCommandQueue.html
+clSetCommandQueueProperty=clSetCommandQueueProperty.html
+clCreateBuffer=clCreateBuffer.html
+clEnqueueReadBuffer=clEnqueueReadBuffer.html
+clEnqueueWriteBuffer=clEnqueueWriteBuffer.html
+clRetainMemObject=clRetainMemObject.html
+clReleaseMemObject=clReleaseMemObject.html
+clGetSupportedImageFormats=clGetSupportedImageFormats.html
+clEnqueueReadImage=clEnqueueReadImage.html
+clEnqueueWriteImage=clEnqueueWriteImage.html
+clEnqueueCopyImage=clEnqueueCopyImage.html
+clEnqueueCopyImageToBuffer=clEnqueueCopyImageToBuffer.html
+clEnqueueCopyBufferToImage=clEnqueueCopyBufferToImage.html
+clEnqueueMapBuffer=clEnqueueMapBuffer.html
+clEnqueueMapImage=clEnqueueMapImage.html
+clEnqueueUnmapMemObject=clEnqueueUnmapMemObject.html
+clGetMemObjectInfo=clGetMemObjectInfo.html
+clGetImageInfo=clGetImageInfo.html
+clCreateSampler=clCreateSampler.html
+clRetainSampler=clRetainSampler.html
+clReleaseSampler=clReleaseSampler.html
+clGetSamplerInfo=clGetSamplerInfo.html
+clCreateProgramWithSource=clCreateProgramWithSource.html
+clCreateProgramWithBinary=clCreateProgramWithBinary.html
+clRetainProgram=clRetainProgram.html
+clReleaseProgram=clReleaseProgram.html
+clUnloadCompiler=clUnloadCompiler.html
+clBuildProgram=clBuildProgram.html
+clGetProgramInfo=clGetProgramInfo.html
+clGetProgramBuildInfo=clGetProgramBuildInfo.html
+clCreateKernel=clCreateKernel.html
+clCreateKernelsInProgram=clCreateKernelsInProgram.html
+clRetainKernel=clRetainKernel.html
+clReleaseKernel=clReleaseKernel.html
+clSetKernelArg=clSetKernelArg.html
+clGetKernelInfo=clGetKernelInfo.html
+clGetKernelWorkGroupInfo=clGetKernelWorkGroupInfo.html
+clEnqueueNDRangeKernel=clEnqueueNDRangeKernel.html
+clEnqueueTask=clEnqueueTask.html
+clEnqueueNativeKernel=clEnqueueNativeKernel.html
+clWaitForEvents=clWaitForEvents.html
+clGetEventInfo=clGetEventInfo.html
+clRetainEvent=clRetainEvent.html
+clReleaseEvent=clReleaseEvent.html
+clEnqueueMarker=clEnqueueMarker.html
+clEnqueueWaitForEvents=clEnqueueWaitForEvents.html
+clEnqueueBarrier=clEnqueueBarrier.html
+clGetEventProfilingInfo=clGetEventProfilingInfo.html
+clFlush=clFlush.html
+clFinish=clFinish.html
+clGetExtensionFunctionAddress=clGetExtensionFunctionAddress.html
+clCreateFromGLBuffer=clCreateFromGLBuffer.html
+clCreateFromGLRenderbuffer=clCreateFromGLRenderbuffer.html
+clEnqueueAcquireGLObjects=clEnqueueAcquireGLObjects.html
+clEnqueueReleaseGLObjects=clEnqueueReleaseGLObjects.html
+clGetGLObjectInfo=clGetGLObjectInfo.html
+clGetGLTextureInfo=clGetGLTextureInfo.html
|