JavaCL: some Javadoc fixes

ochafik · ochafik · commit 061b588c511b · 2011-07-25T20:45:27.000Z
diff --git a/Core/src/main/java/com/nativelibs4java/opencl/CLDevice.java b/Core/src/main/java/com/nativelibs4java/opencl/CLDevice.java
@@ -52,11 +52,11 @@
 
 /**
  * OpenCL device (CPU, GPU...).<br/>
- * Devices are retrieved from a CLPlatform
- * @see CLPlatform#listDevices(java.util.EnumSet, boolean)
- * @see CLPlatform#listAllDevices(boolean)
- * @see CLPlatform#listCPUDevices(boolean)
- * @see CLPlatform#listGPUDevices(boolean)
+ * Devices are retrieved from a CLPlatform through 
+ * {@link CLPlatform#listDevices(java.util.EnumSet, boolean) },
+ * {@link CLPlatform#listAllDevices(boolean) },
+ * {@link CLPlatform#listCPUDevices(boolean) },
+ * {@link CLPlatform#listGPUDevices(boolean) }
  */
 @SuppressWarnings("unused")
 public class CLDevice extends CLAbstractEntity<cl_device_id> {
diff --git a/Core/src/main/java/com/nativelibs4java/opencl/CLImage.java b/Core/src/main/java/com/nativelibs4java/opencl/CLImage.java
@@ -171,8 +171,8 @@ protected Pair<ByteBuffer, CLEvent> map(CLQueue queue, MapFlags flags,
     }
 
     /**
-     * @see CLImage2D#map(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLMem.MapFlags, com.nativelibs4java.opencl.CLEvent[])
-     * @see CLImage3D#map(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLMem.MapFlags, com.nativelibs4java.opencl.CLEvent[])
+     * see {@link CLImage2D#map(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLMem.MapFlags, com.nativelibs4java.opencl.CLEvent[]) }
+     * see {@link CLImage3D#map(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLMem.MapFlags, com.nativelibs4java.opencl.CLEvent[]) }
      * @param queue
      * @param buffer
      * @param eventsToWaitFor
diff --git a/Core/src/main/java/com/nativelibs4java/opencl/CLImage2D.java b/Core/src/main/java/com/nativelibs4java/opencl/CLImage2D.java
@@ -48,12 +48,12 @@
 
 /**
  * OpenCL 2D Image Memory Object<br/>
- * @see CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, java.awt.Image, boolean)
- * @see CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long)
- * @see CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long)
- * @see CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, java.nio.Buffer, boolean)
- * @see CLContext#createImage2DFromGLRenderBuffer(com.nativelibs4java.opencl.CLMem.Usage, int)
- * @see CLContext#createImage2DFromGLTexture2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLContext.GLTextureTarget, int, int) 
+ * see {@link CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, java.awt.Image, boolean) }
+ * see {@link CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long) }
+ * see {@link CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long) }
+ * see {@link CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, java.nio.Buffer, boolean) }
+ * see {@link CLContext#createImage2DFromGLRenderBuffer(com.nativelibs4java.opencl.CLMem.Usage, int) }
+ * see {@link CLContext#createImage2DFromGLTexture2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLContext.GLTextureTarget, int, int) } 
  * @author Olivier Chafik
  */
 public class CLImage2D extends CLImage {
diff --git a/Core/src/main/java/com/nativelibs4java/opencl/CLImage3D.java b/Core/src/main/java/com/nativelibs4java/opencl/CLImage3D.java
@@ -41,10 +41,10 @@
 import static org.bridj.Pointer.*;
 /**
  * OpenCL 3D Image Memory Object<br/>
- * @see CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long)
- * @see CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long)
- * @see CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long, java.nio.Buffer, boolean)
- * @see CLContext#createImage3DFromGLTexture3D(com.nativelibs4java.opencl.CLMem.Usage, int, int) 
+ * see {@link CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long) }
+ * see {@link CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long) }
+ * see {@link CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long, java.nio.Buffer, boolean) }
+ * see {@link CLContext#createImage3DFromGLTexture3D(com.nativelibs4java.opencl.CLMem.Usage, int, int) } 
  * @author Olivier Chafik
  */
 public class CLImage3D extends CLImage2D {
diff --git a/Core/src/main/java/com/nativelibs4java/opencl/CLImageFormat.java b/Core/src/main/java/com/nativelibs4java/opencl/CLImageFormat.java
@@ -39,7 +39,7 @@
 
 /**
  * OpenCL Image Format
- * @see CLContext#getSupportedImageFormats(com.nativelibs4java.opencl.CLMem.Flags, com.nativelibs4java.opencl.CLMem.ObjectType) 
+ * see {@link CLContext#getSupportedImageFormats(com.nativelibs4java.opencl.CLMem.Flags, com.nativelibs4java.opencl.CLMem.ObjectType) } 
  * @author Olivier Chafik
  */
 public class CLImageFormat {
diff --git a/Core/src/main/java/com/nativelibs4java/opencl/CLPlatform.java b/Core/src/main/java/com/nativelibs4java/opencl/CLPlatform.java
@@ -47,7 +47,7 @@
 
 /**
  * OpenCL implementation entry point.
- * @see JavaCL#listPlatforms() 
+ * see {@link JavaCL#listPlatforms() } 
  * @author Olivier Chafik
  */
 public class CLPlatform extends CLAbstractEntity<cl_platform_id> {
@@ -75,7 +75,7 @@ protected void clear() {
     /**
      * Lists all the devices of the platform
      * @param onlyAvailable if true, only returns devices that are available
-     * @see CLPlatform#listDevices(java.util.EnumSet, boolean)
+     * see {@link CLPlatform#listDevices(java.util.EnumSet, boolean) }
      */
     public CLDevice[] listAllDevices(boolean onlyAvailable) {
         return listDevices(EnumSet.allOf(CLDevice.Type.class), onlyAvailable);
@@ -84,7 +84,7 @@ public CLDevice[] listAllDevices(boolean onlyAvailable) {
     /**
      * Lists all the GPU devices of the platform
      * @param onlyAvailable if true, only returns GPU devices that are available
-     * @see CLPlatform#listDevices(java.util.EnumSet, boolean)
+     * see {@link CLPlatform#listDevices(java.util.EnumSet, boolean) }
      */
     public CLDevice[] listGPUDevices(boolean onlyAvailable) {
         try {
@@ -100,7 +100,7 @@ public CLDevice[] listGPUDevices(boolean onlyAvailable) {
     /**
      * Lists all the CPU devices of the platform
      * @param onlyAvailable if true, only returns CPU devices that are available
-     * @see CLPlatform#listDevices(java.util.EnumSet, boolean)
+     * see {@link CLPlatform#listDevices(java.util.EnumSet, boolean) }
      */
     public CLDevice[] listCPUDevices(boolean onlyAvailable) {
         try {
@@ -159,71 +159,71 @@ else if (v instanceof Pointer)
      */
     public enum DeviceFeature {
         /**
-         * Prefer CPU devices (see @see CLDevice#getType())
+         * Prefer CPU devices (see {@link CLDevice#getType() })
          */
         CPU {
             Comparable extractValue(CLDevice device) {
                 return device.getType().contains(CLDevice.Type.CPU) ? 1 : 0;
             }
         },
         /**
-         * Prefer GPU devices (see @see CLDevice#getType())
+         * Prefer GPU devices (see {@link CLDevice#getType() })
          */
         GPU {
             Comparable extractValue(CLDevice device) {
                 return device.getType().contains(CLDevice.Type.GPU) ? 1 : 0;
             }
         },
         /**
-         * Prefer Accelerator devices (see @see CLDevice#getType())
+         * Prefer Accelerator devices (see {@link CLDevice#getType() })
          */
         Accelerator {
             Comparable extractValue(CLDevice device) {
                 return device.getType().contains(CLDevice.Type.Accelerator) ? 1 : 0;
             }
         },
         /**
-         * Prefer devices with the most compute units (see @see CLDevice#getMaxComputeUnits())
+         * Prefer devices with the most compute units (see {@link CLDevice#getMaxComputeUnits() })
          */
         MaxComputeUnits {
             Comparable extractValue(CLDevice device) {
                 return device.getMaxComputeUnits();
             }
         },
         /**
-         * Prefer devices with the same byte ordering as the hosting platform (@see CLDevice#getKernelsDefaultByteOrder())
+         * Prefer devices with the same byte ordering as the hosting platform (see {@link CLDevice#getKernelsDefaultByteOrder() })
          */
         NativeEndianness {
             Comparable extractValue(CLDevice device) {
                 return device.getKernelsDefaultByteOrder() == ByteOrder.nativeOrder() ? 1 : 0;
             }
         },
         /**
-         * Prefer devices that support double-precision float computations (@see CLDevice#isDoubleSupported())
+         * Prefer devices that support double-precision float computations (see {@link CLDevice#isDoubleSupported() })
          */
         DoubleSupport {
             Comparable extractValue(CLDevice device) {
                 return device.isDoubleSupported() ? 1 : 0;
             }
         },
         /**
-         * Prefer devices that support images and with the most supported image formats (@see CLDevice#hasImageSupport())
+         * Prefer devices that support images and with the most supported image formats (see {@link CLDevice#hasImageSupport() })
          */
         ImageSupport {
             Comparable extractValue(CLDevice device) {
                 return device.hasImageSupport() ? 1 : 0;
             }
         },
         /**
-         * Prefer devices that support out of order queues (@see CLDevice#hasOutOfOrderQueueSupport())
+         * Prefer devices that support out of order queues (see {@link CLDevice#hasOutOfOrderQueueSupport() })
          */
         OutOfOrderQueueSupport {
             Comparable extractValue(CLDevice device) {
                 return device.hasOutOfOrderQueueSupport() ? 1 : 0;
             }
         },
         /**
-         * Prefer devices with the greatest variety of supported image formats (@see CLContext#getSupportedImageFormats())
+         * Prefer devices with the greatest variety of supported image formats (see {@link CLContext#getSupportedImageFormats() })
          */
         MostImageFormats {
             Comparable extractValue(CLDevice device) {
diff --git a/Core/src/main/java/com/nativelibs4java/opencl/CLProgram.java b/Core/src/main/java/com/nativelibs4java/opencl/CLProgram.java
@@ -103,8 +103,8 @@
  *
  * A program can be compiled on the fly (costly) but its binaries can be stored and
  * loaded back in subsequent executions to avoid recompilation.<br>
- * By default, program binaries are automatically cached on stable platforms (which currently exclude ATI Stream), but the caching can be forced on/off with * @see CLContext#setCached(boolean).<br>
- * To create a program from sources, please use @see CLContext#createProgram(java.lang.String[]) 
+ * By default, program binaries are automatically cached on stable platforms (which currently exclude ATI Stream), but the caching can be forced on/off with * see {@link CLContext#setCached(boolean) }.<br>
+ * To create a program from sources, please use see {@link CLContext#createProgram(java.lang.String[]) } 
  * @author Olivier Chafik
  */
 public class CLProgram extends CLAbstractEntity<cl_program> {
diff --git a/Core/src/main/java/com/nativelibs4java/opencl/CLQueue.java b/Core/src/main/java/com/nativelibs4java/opencl/CLQueue.java
@@ -53,12 +53,12 @@
  * Sharing of objects across multiple command-queues will require the application to perform appropriate synchronization.<br/>
  * <br/>
  * A queue is bound to a single device.
- * @see CLDevice#createQueue(com.nativelibs4java.opencl.CLContext, com.nativelibs4java.opencl.CLDevice.QueueProperties[]) 
- * @see CLDevice#createOutOfOrderQueue(com.nativelibs4java.opencl.CLContext)
- * @see CLDevice#createProfilingQueue(com.nativelibs4java.opencl.CLContext)
- * @see CLContext#createDefaultQueue(com.nativelibs4java.opencl.CLDevice.QueueProperties[])
- * @see CLContext#createDefaultOutOfOrderQueue()
- * @see CLContext#createDefaultProfilingQueue()
+ * see {@link CLDevice#createQueue(com.nativelibs4java.opencl.CLContext, com.nativelibs4java.opencl.CLDevice.QueueProperties[]) } 
+ * see {@link CLDevice#createOutOfOrderQueue(com.nativelibs4java.opencl.CLContext) }
+ * see {@link CLDevice#createProfilingQueue(com.nativelibs4java.opencl.CLContext) }
+ * see {@link CLContext#createDefaultQueue(com.nativelibs4java.opencl.CLDevice.QueueProperties[]) }
+ * see {@link CLContext#createDefaultOutOfOrderQueue() }
+ * see {@link CLContext#createDefaultProfilingQueue() }
  * @author Olivier Chafik
  *
  */
diff --git a/Core/src/main/java/com/nativelibs4java/opencl/CLSampler.java b/Core/src/main/java/com/nativelibs4java/opencl/CLSampler.java
@@ -53,7 +53,7 @@
  * The built-in functions to read from an image in a kernel take a sampler as an argument. <br/>
  * The sampler arguments to the image read function can be sampler objects created using OpenCL functions and passed as argument values to the kernel or can be samplers declared inside a kernel.
  *  <br/>
- * @see CLContext#createSampler(boolean, com.nativelibs4java.opencl.CLSampler.AddressingMode, com.nativelibs4java.opencl.CLSampler.FilterMode) 
+ * see {@link CLContext#createSampler(boolean, com.nativelibs4java.opencl.CLSampler.AddressingMode, com.nativelibs4java.opencl.CLSampler.FilterMode) } 
  * @author Olivier Chafik
  */
 public class CLSampler extends CLAbstractEntity<cl_sampler> {
diff --git a/Core/src/main/java/com/nativelibs4java/opencl/JavaCL.java b/Core/src/main/java/com/nativelibs4java/opencl/JavaCL.java
@@ -187,7 +187,7 @@ public static void unloadCompiler() {
 
 	/**
 	 * Returns the "best" OpenCL device (currently, the one that has the largest amount of compute units).<br>
-	 * For more control on what is to be considered a better device, please use the @see JavaCL#getBestDevice(CLPlatform.DeviceFeature[]) variant.<br>
+	 * For more control on what is to be considered a better device, please use the {@link JavaCL#getBestDevice(CLPlatform.DeviceFeature[]) } variant.<br>
 	 * This is currently equivalent to <code>getBestDevice(MaxComputeUnits)</code>
 	 */
     public static CLDevice getBestDevice() {
@@ -205,14 +205,14 @@ public static CLDevice getBestDevice(CLPlatform.DeviceFeature... preferredFeatur
         return CLPlatform.getBestDevice(Arrays.asList(preferredFeatures), devices);
     }
     /**
-     * Creates an OpenCL context with the "best" device (see @see JavaCL#getBestDevice())
+     * Creates an OpenCL context with the "best" device (see {@link JavaCL#getBestDevice() })
      */
 	public static CLContext createBestContext() {
         return createBestContext(DeviceFeature.MaxComputeUnits);
 	}
 
     /**
-     * Creates an OpenCL context with the "best" device based on the comparison of the provided prioritized device feature (see @see JavaCL#getBestDevice(CLPlatform.DeviceFeature))
+     * Creates an OpenCL context with the "best" device based on the comparison of the provided prioritized device feature (see {@link JavaCL#getBestDevice(CLPlatform.DeviceFeature) })
      */
 	public static CLContext createBestContext(CLPlatform.DeviceFeature... preferredFeatures) {
 		CLDevice device = getBestDevice(preferredFeatures);
diff --git a/Core/src/main/java/com/nativelibs4java/util/EnumValues.java b/Core/src/main/java/com/nativelibs4java/util/EnumValues.java
@@ -96,7 +96,7 @@ public static <E extends Enum<?>> long getValue(E enumItem) {
 
     /**
      * Get the integer value resulting from ORing all the values of all the enum items present in the enum set.
-     * @see EnumValues#getValue(java.lang.Enum)
+     * see {@link EnumValues#getValue(java.lang.Enum) }
      * @see EnumValue
      * @param enumItem
      * @return
diff --git a/Core/src/main/velocity/com/nativelibs4java/opencl/CLContext.java b/Core/src/main/velocity/com/nativelibs4java/opencl/CLContext.java
@@ -107,16 +107,16 @@ public class CLContext extends CLAbstractEntity<cl_context> {
 	/**
 	 * Change whether program binaries are automatically cached or not.<br>
 	 * By default it is true, it can be set to false with the "javacl.cacheBinaries" Java property or the "JAVACL_CACHE_BINARIES" environment variable (when set to "0").<br>
-	 * Each program can be set to be cached or not using @see CLProgram#setCached(boolean).<br>
+	 * Each program can be set to be cached or not using {@link CLProgram#setCached(boolean) }.<br>
 	 * Caching of binaries might be disabled by default on some platforms (ATI Stream, for instance).
 	 */ 
 	public synchronized void setCacheBinaries(boolean cacheBinaries) {
 		this.cacheBinaries = cacheBinaries;
 	}
 	/**
 	 * Says whether program binaries are automatically cached or not.<br>
-	 * By default it is true, it can be set to false with the "javacl.cacheBinaries" Java property, the "JAVACL_CACHE_BINARIES" environment variable (when set to "0") or the @see JavaCL#setCacheBinaries(boolean) method.<br>
-	 * Each program can be set to be cached or not using @see CLProgram#setCached(boolean).<br>
+	 * By default it is true, it can be set to false with the "javacl.cacheBinaries" Java property, the "JAVACL_CACHE_BINARIES" environment variable (when set to "0") or the {@link JavaCL#setCacheBinaries(boolean) } method.<br>
+	 * Each program can be set to be cached or not using {@link CLProgram#setCached(boolean) }.<br>
 	 * Caching of binaries might be disabled by default on some platforms (ATI Stream, for instance).
 	 */ 
 	public synchronized boolean getCacheBinaries() {
@@ -343,8 +343,8 @@ private static <T extends CLMem> T markAsGL(T mem) {
     /**
      * Makes an OpenGL Vertex Buffer Object (VBO) visible to OpenCL as a buffer object.<br/>
      * Note that memory objects shared with OpenGL must be acquired / released before / after use from OpenCL.
-     * @see CLMem#acquireGLObject(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLEvent[])
-     * @see CLMem#releaseGLObject(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLEvent[]) 
+     * see {@link CLMem#acquireGLObject(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLEvent[]) }
+     * see {@link CLMem#releaseGLObject(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLEvent[]) } 
      * @param openGLBufferObject Identifier of a VBO, as generated by glGenBuffers
      */
 	@SuppressWarnings("deprecation")
@@ -361,8 +361,8 @@ public CLBuffer<Byte> createBufferFromGLBuffer(CLMem.Usage usage, int openGLBuff
     /**
      * Makes an OpenGL Render Buffer visible to OpenCL as a 2D image.<br/>
      * Note that memory objects shared with OpenGL must be acquired / released before / after use from OpenCL.
-     * @see CLMem#acquireGLObject(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLEvent[])
-     * @see CLMem#releaseGLObject(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLEvent[])
+     * see {@link CLMem#acquireGLObject(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLEvent[]) }
+     * see {@link CLMem#releaseGLObject(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLEvent[]) }
      * @param openGLBufferObject Identifier of an OpenGL render buffer
      */
 	@SuppressWarnings("deprecation")
diff --git a/JavaCL/src/main/java/com/nativelibs4java/opencl/util/ParallelRandom.java b/JavaCL/src/main/java/com/nativelibs4java/opencl/util/ParallelRandom.java
@@ -199,9 +199,9 @@ public CLQueue getQueue() {
 	}
 	
     /**
-     * Number of random numbers generated at each call of @see ParallelRandom#next() or @see ParallelRandom#next(IntBuffer)<br>
+     * Number of random numbers generated at each call of {@link ParallelRandom#next() } or {@link ParallelRandom#next(IntBuffer) }<br>
      * The numbers might not all be generated exactly in parallel, the level of parallelism is implementation-dependent.
-     * @return size of each buffer returned by @see ParallelRandom#next()
+     * @return size of each buffer returned by {@link ParallelRandom#next() }
      */
     public int getParallelSize() {
         return parallelSize;
@@ -222,7 +222,7 @@ public synchronized CLEvent doNext() {
     }
 
     /**
-     * Copies the next @see ParallelRandom#getParallelSize() random integers in the provided output buffer
+     * Copies the next {@link ParallelRandom#getParallelSize() } random integers in the provided output buffer
      * @param output
      */
     public synchronized void next(Pointer<Integer> output) {
@@ -232,9 +232,9 @@ public synchronized void next(Pointer<Integer> output) {
 
     
     /**
-     * Returns a direct NIO buffer containing the next @see ParallelRandom#getParallelSize() random integers.<br>
+     * Returns a direct NIO buffer containing the next {@link ParallelRandom#getParallelSize() } random integers.<br>
      * This buffer is read only and will only be valid until any of the "next" method is called again.
-     * @param output buffer of capacity @see ParallelRandom#getParallelSize()
+     * @param output buffer of capacity ; see {@link ParallelRandom#getParallelSize() }
      */
     public synchronized Pointer<Integer> next() {
         CLEvent evt = doNext();
