Skip to content

Commit 061b588

Browse files
ochafikochafik
committed
JavaCL: some Javadoc fixes
1 parent 87b7224 commit 061b588

13 files changed

Lines changed: 56 additions & 56 deletions

File tree

‎Core/src/main/java/com/nativelibs4java/opencl/CLDevice.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@
5252

5353
/**
5454
* OpenCL device (CPU, GPU...).<br/>
55-
* Devices are retrieved from a CLPlatform
56-
* @see CLPlatform#listDevices(java.util.EnumSet, boolean)
57-
* @see CLPlatform#listAllDevices(boolean)
58-
* @see CLPlatform#listCPUDevices(boolean)
59-
* @see CLPlatform#listGPUDevices(boolean)
55+
* Devices are retrieved from a CLPlatform through
56+
* {@link CLPlatform#listDevices(java.util.EnumSet, boolean) },
57+
* {@link CLPlatform#listAllDevices(boolean) },
58+
* {@link CLPlatform#listCPUDevices(boolean) },
59+
* {@link CLPlatform#listGPUDevices(boolean) }
6060
*/
6161
@SuppressWarnings("unused")
6262
public class CLDevice extends CLAbstractEntity<cl_device_id> {

‎Core/src/main/java/com/nativelibs4java/opencl/CLImage.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,8 @@ protected Pair<ByteBuffer, CLEvent> map(CLQueue queue, MapFlags flags,
171171
}
172172

173173
/**
174-
* @see CLImage2D#map(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLMem.MapFlags, com.nativelibs4java.opencl.CLEvent[])
175-
* @see CLImage3D#map(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLMem.MapFlags, com.nativelibs4java.opencl.CLEvent[])
174+
* see {@link CLImage2D#map(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLMem.MapFlags, com.nativelibs4java.opencl.CLEvent[]) }
175+
* see {@link CLImage3D#map(com.nativelibs4java.opencl.CLQueue, com.nativelibs4java.opencl.CLMem.MapFlags, com.nativelibs4java.opencl.CLEvent[]) }
176176
* @param queue
177177
* @param buffer
178178
* @param eventsToWaitFor

‎Core/src/main/java/com/nativelibs4java/opencl/CLImage2D.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@
4848

4949
/**
5050
* OpenCL 2D Image Memory Object<br/>
51-
* @see CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, java.awt.Image, boolean)
52-
* @see CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long)
53-
* @see CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long)
54-
* @see CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, java.nio.Buffer, boolean)
55-
* @see CLContext#createImage2DFromGLRenderBuffer(com.nativelibs4java.opencl.CLMem.Usage, int)
56-
* @see CLContext#createImage2DFromGLTexture2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLContext.GLTextureTarget, int, int)
51+
* see {@link CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, java.awt.Image, boolean) }
52+
* see {@link CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long) }
53+
* see {@link CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long) }
54+
* see {@link CLContext#createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, java.nio.Buffer, boolean) }
55+
* see {@link CLContext#createImage2DFromGLRenderBuffer(com.nativelibs4java.opencl.CLMem.Usage, int) }
56+
* see {@link CLContext#createImage2DFromGLTexture2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLContext.GLTextureTarget, int, int) }
5757
* @author Olivier Chafik
5858
*/
5959
public class CLImage2D extends CLImage {

‎Core/src/main/java/com/nativelibs4java/opencl/CLImage3D.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@
4141
import static org.bridj.Pointer.*;
4242
/**
4343
* OpenCL 3D Image Memory Object<br/>
44-
* @see CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long)
45-
* @see CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long)
46-
* @see CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long, java.nio.Buffer, boolean)
47-
* @see CLContext#createImage3DFromGLTexture3D(com.nativelibs4java.opencl.CLMem.Usage, int, int)
44+
* see {@link CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long) }
45+
* see {@link CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long) }
46+
* see {@link CLContext#createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long, java.nio.Buffer, boolean) }
47+
* see {@link CLContext#createImage3DFromGLTexture3D(com.nativelibs4java.opencl.CLMem.Usage, int, int) }
4848
* @author Olivier Chafik
4949
*/
5050
public class CLImage3D extends CLImage2D {

‎Core/src/main/java/com/nativelibs4java/opencl/CLImageFormat.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
/**
4141
* OpenCL Image Format
42-
* @see CLContext#getSupportedImageFormats(com.nativelibs4java.opencl.CLMem.Flags, com.nativelibs4java.opencl.CLMem.ObjectType)
42+
* see {@link CLContext#getSupportedImageFormats(com.nativelibs4java.opencl.CLMem.Flags, com.nativelibs4java.opencl.CLMem.ObjectType) }
4343
* @author Olivier Chafik
4444
*/
4545
public class CLImageFormat {

‎Core/src/main/java/com/nativelibs4java/opencl/CLPlatform.java‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747

4848
/**
4949
* OpenCL implementation entry point.
50-
* @see JavaCL#listPlatforms()
50+
* see {@link JavaCL#listPlatforms() }
5151
* @author Olivier Chafik
5252
*/
5353
public class CLPlatform extends CLAbstractEntity<cl_platform_id> {
@@ -75,7 +75,7 @@ protected void clear() {
7575
/**
7676
* Lists all the devices of the platform
7777
* @param onlyAvailable if true, only returns devices that are available
78-
* @see CLPlatform#listDevices(java.util.EnumSet, boolean)
78+
* see {@link CLPlatform#listDevices(java.util.EnumSet, boolean) }
7979
*/
8080
public CLDevice[] listAllDevices(boolean onlyAvailable) {
8181
return listDevices(EnumSet.allOf(CLDevice.Type.class), onlyAvailable);
@@ -84,7 +84,7 @@ public CLDevice[] listAllDevices(boolean onlyAvailable) {
8484
/**
8585
* Lists all the GPU devices of the platform
8686
* @param onlyAvailable if true, only returns GPU devices that are available
87-
* @see CLPlatform#listDevices(java.util.EnumSet, boolean)
87+
* see {@link CLPlatform#listDevices(java.util.EnumSet, boolean) }
8888
*/
8989
public CLDevice[] listGPUDevices(boolean onlyAvailable) {
9090
try {
@@ -100,7 +100,7 @@ public CLDevice[] listGPUDevices(boolean onlyAvailable) {
100100
/**
101101
* Lists all the CPU devices of the platform
102102
* @param onlyAvailable if true, only returns CPU devices that are available
103-
* @see CLPlatform#listDevices(java.util.EnumSet, boolean)
103+
* see {@link CLPlatform#listDevices(java.util.EnumSet, boolean) }
104104
*/
105105
public CLDevice[] listCPUDevices(boolean onlyAvailable) {
106106
try {
@@ -159,71 +159,71 @@ else if (v instanceof Pointer)
159159
*/
160160
public enum DeviceFeature {
161161
/**
162-
* Prefer CPU devices (see @see CLDevice#getType())
162+
* Prefer CPU devices (see {@link CLDevice#getType() })
163163
*/
164164
CPU {
165165
Comparable extractValue(CLDevice device) {
166166
return device.getType().contains(CLDevice.Type.CPU) ? 1 : 0;
167167
}
168168
},
169169
/**
170-
* Prefer GPU devices (see @see CLDevice#getType())
170+
* Prefer GPU devices (see {@link CLDevice#getType() })
171171
*/
172172
GPU {
173173
Comparable extractValue(CLDevice device) {
174174
return device.getType().contains(CLDevice.Type.GPU) ? 1 : 0;
175175
}
176176
},
177177
/**
178-
* Prefer Accelerator devices (see @see CLDevice#getType())
178+
* Prefer Accelerator devices (see {@link CLDevice#getType() })
179179
*/
180180
Accelerator {
181181
Comparable extractValue(CLDevice device) {
182182
return device.getType().contains(CLDevice.Type.Accelerator) ? 1 : 0;
183183
}
184184
},
185185
/**
186-
* Prefer devices with the most compute units (see @see CLDevice#getMaxComputeUnits())
186+
* Prefer devices with the most compute units (see {@link CLDevice#getMaxComputeUnits() })
187187
*/
188188
MaxComputeUnits {
189189
Comparable extractValue(CLDevice device) {
190190
return device.getMaxComputeUnits();
191191
}
192192
},
193193
/**
194-
* Prefer devices with the same byte ordering as the hosting platform (@see CLDevice#getKernelsDefaultByteOrder())
194+
* Prefer devices with the same byte ordering as the hosting platform (see {@link CLDevice#getKernelsDefaultByteOrder() })
195195
*/
196196
NativeEndianness {
197197
Comparable extractValue(CLDevice device) {
198198
return device.getKernelsDefaultByteOrder() == ByteOrder.nativeOrder() ? 1 : 0;
199199
}
200200
},
201201
/**
202-
* Prefer devices that support double-precision float computations (@see CLDevice#isDoubleSupported())
202+
* Prefer devices that support double-precision float computations (see {@link CLDevice#isDoubleSupported() })
203203
*/
204204
DoubleSupport {
205205
Comparable extractValue(CLDevice device) {
206206
return device.isDoubleSupported() ? 1 : 0;
207207
}
208208
},
209209
/**
210-
* Prefer devices that support images and with the most supported image formats (@see CLDevice#hasImageSupport())
210+
* Prefer devices that support images and with the most supported image formats (see {@link CLDevice#hasImageSupport() })
211211
*/
212212
ImageSupport {
213213
Comparable extractValue(CLDevice device) {
214214
return device.hasImageSupport() ? 1 : 0;
215215
}
216216
},
217217
/**
218-
* Prefer devices that support out of order queues (@see CLDevice#hasOutOfOrderQueueSupport())
218+
* Prefer devices that support out of order queues (see {@link CLDevice#hasOutOfOrderQueueSupport() })
219219
*/
220220
OutOfOrderQueueSupport {
221221
Comparable extractValue(CLDevice device) {
222222
return device.hasOutOfOrderQueueSupport() ? 1 : 0;
223223
}
224224
},
225225
/**
226-
* Prefer devices with the greatest variety of supported image formats (@see CLContext#getSupportedImageFormats())
226+
* Prefer devices with the greatest variety of supported image formats (see {@link CLContext#getSupportedImageFormats() })
227227
*/
228228
MostImageFormats {
229229
Comparable extractValue(CLDevice device) {

‎Core/src/main/java/com/nativelibs4java/opencl/CLProgram.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@
103103
*
104104
* A program can be compiled on the fly (costly) but its binaries can be stored and
105105
* loaded back in subsequent executions to avoid recompilation.<br>
106-
* 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>
107-
* To create a program from sources, please use @see CLContext#createProgram(java.lang.String[])
106+
* 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>
107+
* To create a program from sources, please use see {@link CLContext#createProgram(java.lang.String[]) }
108108
* @author Olivier Chafik
109109
*/
110110
public class CLProgram extends CLAbstractEntity<cl_program> {

‎Core/src/main/java/com/nativelibs4java/opencl/CLQueue.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@
5353
* Sharing of objects across multiple command-queues will require the application to perform appropriate synchronization.<br/>
5454
* <br/>
5555
* A queue is bound to a single device.
56-
* @see CLDevice#createQueue(com.nativelibs4java.opencl.CLContext, com.nativelibs4java.opencl.CLDevice.QueueProperties[])
57-
* @see CLDevice#createOutOfOrderQueue(com.nativelibs4java.opencl.CLContext)
58-
* @see CLDevice#createProfilingQueue(com.nativelibs4java.opencl.CLContext)
59-
* @see CLContext#createDefaultQueue(com.nativelibs4java.opencl.CLDevice.QueueProperties[])
60-
* @see CLContext#createDefaultOutOfOrderQueue()
61-
* @see CLContext#createDefaultProfilingQueue()
56+
* see {@link CLDevice#createQueue(com.nativelibs4java.opencl.CLContext, com.nativelibs4java.opencl.CLDevice.QueueProperties[]) }
57+
* see {@link CLDevice#createOutOfOrderQueue(com.nativelibs4java.opencl.CLContext) }
58+
* see {@link CLDevice#createProfilingQueue(com.nativelibs4java.opencl.CLContext) }
59+
* see {@link CLContext#createDefaultQueue(com.nativelibs4java.opencl.CLDevice.QueueProperties[]) }
60+
* see {@link CLContext#createDefaultOutOfOrderQueue() }
61+
* see {@link CLContext#createDefaultProfilingQueue() }
6262
* @author Olivier Chafik
6363
*
6464
*/

‎Core/src/main/java/com/nativelibs4java/opencl/CLSampler.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
* The built-in functions to read from an image in a kernel take a sampler as an argument. <br/>
5454
* 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.
5555
* <br/>
56-
* @see CLContext#createSampler(boolean, com.nativelibs4java.opencl.CLSampler.AddressingMode, com.nativelibs4java.opencl.CLSampler.FilterMode)
56+
* see {@link CLContext#createSampler(boolean, com.nativelibs4java.opencl.CLSampler.AddressingMode, com.nativelibs4java.opencl.CLSampler.FilterMode) }
5757
* @author Olivier Chafik
5858
*/
5959
public class CLSampler extends CLAbstractEntity<cl_sampler> {

‎Core/src/main/java/com/nativelibs4java/opencl/JavaCL.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ public static void unloadCompiler() {
187187

188188
/**
189189
* Returns the "best" OpenCL device (currently, the one that has the largest amount of compute units).<br>
190-
* For more control on what is to be considered a better device, please use the @see JavaCL#getBestDevice(CLPlatform.DeviceFeature[]) variant.<br>
190+
* For more control on what is to be considered a better device, please use the {@link JavaCL#getBestDevice(CLPlatform.DeviceFeature[]) } variant.<br>
191191
* This is currently equivalent to <code>getBestDevice(MaxComputeUnits)</code>
192192
*/
193193
public static CLDevice getBestDevice() {
@@ -205,14 +205,14 @@ public static CLDevice getBestDevice(CLPlatform.DeviceFeature... preferredFeatur
205205
return CLPlatform.getBestDevice(Arrays.asList(preferredFeatures), devices);
206206
}
207207
/**
208-
* Creates an OpenCL context with the "best" device (see @see JavaCL#getBestDevice())
208+
* Creates an OpenCL context with the "best" device (see {@link JavaCL#getBestDevice() })
209209
*/
210210
public static CLContext createBestContext() {
211211
return createBestContext(DeviceFeature.MaxComputeUnits);
212212
}
213213

214214
/**
215-
* Creates an OpenCL context with the "best" device based on the comparison of the provided prioritized device feature (see @see JavaCL#getBestDevice(CLPlatform.DeviceFeature))
215+
* Creates an OpenCL context with the "best" device based on the comparison of the provided prioritized device feature (see {@link JavaCL#getBestDevice(CLPlatform.DeviceFeature) })
216216
*/
217217
public static CLContext createBestContext(CLPlatform.DeviceFeature... preferredFeatures) {
218218
CLDevice device = getBestDevice(preferredFeatures);

0 commit comments

Comments
 (0)