Skip to content

Commit c784cda

Browse files
ochafikochafik
committed
Fix all javadoc errors + some of the warnings
1 parent 716d762 commit c784cda

68 files changed

Lines changed: 643 additions & 495 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎libraries/BridJ/src/main/java/org/bridj/BridJ.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,8 @@ public static synchronized void register() {
200200
* overrides for all native methods. Non-default constructors are not
201201
* currently handled.
202202
*
203-
* @param <T>
204-
* @param original
203+
* @param <T> original class type
204+
* @param original class
205205
* @throws IOException
206206
*/
207207
public static <T> Class<? extends T> subclassWithSynchronizedNativeMethods(Class<T> original) throws IOException {

‎libraries/BridJ/src/main/java/org/bridj/DefaultNativeList.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
* TODO : smart rewrite by chunks for removeAll and retainAll !
4646
*
4747
* @author ochafik
48-
* @param <T>
48+
* @param <T> component type
4949
*/
5050
class DefaultNativeList<T> extends AbstractList<T> implements NativeList<T>, RandomAccess {
5151
/*

‎libraries/BridJ/src/main/java/org/bridj/cpp/std/list.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
* std::vector</a> class.
5656
*
5757
* @author ochafik
58-
* @param <T>
58+
* @param <T> list component type
5959
*/
6060
@Template({Type.class})
6161
@Struct(customizer = STL.class)

‎libraries/BridJ/src/main/java/org/bridj/cpp/std/vector.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
* std::vector</a> class.
5252
*
5353
* @author ochafik
54-
* @param <T>
54+
* @param <T> vector component type
5555
*/
5656
@Template({Type.class})
5757
@Struct(customizer = STL.class)

‎libraries/BridJ/src/main/velocity/org/bridj/Pointer.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -720,7 +720,7 @@ public final long getPeer() {
720720
}
721721

722722
/**
723-
* Create a native callback which signature corresponds to the provided calling convention, return type and parameter types, and which redirects calls to the provided Java {@link org.bridj.DynamicCallback} handler.<br/>
723+
* Create a native callback which signature corresponds to the provided calling convention, return type and parameter types, and which redirects calls to the provided Java {@link org.bridj.DynamicCallback} handler.<br>
724724
* For instance, a callback of C signature <code>double (*)(float, int)</code> that adds its two arguments can be created with :<br>
725725
* <code>{@code
726726
* Pointer callback = Pointer.allocateDynamicCallback(
@@ -1937,8 +1937,8 @@ public void updateBuffer(Buffer buffer) {
19371937
//-- primitive (no bool): $prim.Name --
19381938

19391939
/**
1940-
* Create a pointer to the memory location used by a direct NIO ${prim.BufferName}.<br/>
1941-
* If the NIO ${prim.BufferName} is not direct, then its backing Java array is copied to some native memory and will never be updated by changes to the native memory (calls {@link Pointer#pointerTo${prim.CapName}s(${prim.Name}[])}), unless a call to {@link Pointer#updateBuffer(Buffer)} is made manually.<br/>
1940+
* Create a pointer to the memory location used by a direct NIO ${prim.BufferName}.<br>
1941+
* If the NIO ${prim.BufferName} is not direct, then its backing Java array is copied to some native memory and will never be updated by changes to the native memory (calls {@link Pointer#pointerTo${prim.CapName}s(${prim.Name}[])}), unless a call to {@link Pointer#updateBuffer(Buffer)} is made manually.<br>
19421942
* The returned pointer (and its subsequent views returned by {@link Pointer#offset(long)} or {@link Pointer#next(long)}) can be used safely : it retains a reference to the original NIO buffer, so that this latter cannot be garbage collected before the pointer.<br>
19431943
*/
19441944
public static Pointer<${prim.WrapperName}> pointerTo${prim.CapName}s(${prim.BufferName} buffer) {

‎libraries/OpenCL-JNA/Core/src/main/java/com/nativelibs4java/opencl/CLAbstractEntity.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ abstract class CLAbstractEntity<T extends PointerType> {
4747
}
4848

4949
/**
50-
* Manual release of the OpenCL resources represented by this object.<br/>
51-
* Note that resources are automatically released by the garbage collector, so in general there's no need to call this method.<br/>
52-
* In an environment with fast allocation/deallocation of large objects, it might be safer to call release() manually, though.<br/>
50+
* Manual release of the OpenCL resources represented by this object.<br>
51+
* Note that resources are automatically released by the garbage collector, so in general there's no need to call this method.<br>
52+
* In an environment with fast allocation/deallocation of large objects, it might be safer to call release() manually, though.<br>
5353
* Note that release() does not necessarily free the object immediately : OpenCL maintains a reference count for all its objects, and an object released on the Java side might still be pointed to by running kernels or queued operations.
5454
*/
5555
public synchronized void release() {
@@ -107,4 +107,4 @@ public boolean equals(Object obj) {
107107
return getEntity().getPointer().equals(e.getEntity().getPointer());
108108
}
109109

110-
}
110+
}

‎libraries/OpenCL-JNA/Core/src/main/java/com/nativelibs4java/opencl/CLByteBuffer.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@
3535
import com.nativelibs4java.opencl.library.OpenCLLibrary.cl_mem;
3636

3737
/**
38-
* OpenCL Memory Buffer Object.<br/>
39-
* A buffer object stores a one-dimensional collection of elements.<br/>
40-
* Elements of a buffer object can be a scalar data type (such as an int, float), vector data type, or a user-defined structure.<br/>
38+
* OpenCL Memory Buffer Object.<br>
39+
* A buffer object stores a one-dimensional collection of elements.<br>
40+
* Elements of a buffer object can be a scalar data type (such as an int, float), vector data type, or a user-defined structure.<br>
4141
* see {@link CLContext#createByteBuffer(com.nativelibs4java.opencl.CLMem.Usage, long) }
4242
* see {@link CLContext#createByteBuffer(com.nativelibs4java.opencl.CLMem.Usage, java.nio.Buffer, boolean) }
4343
* @author Olivier Chafik

‎libraries/OpenCL-JNA/Core/src/main/java/com/nativelibs4java/opencl/CLCharBuffer.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
import com.nativelibs4java.opencl.library.OpenCLLibrary.cl_mem;
3636

3737
/**
38-
* OpenCL Memory Buffer Object with Character values.<br/>
38+
* OpenCL Memory Buffer Object with Character values.<br>
3939
* see {@link CLContext#createCharBuffer(com.nativelibs4java.opencl.CLMem.Usage, long) }
4040
* see {@link CLContext#createCharBuffer(com.nativelibs4java.opencl.CLMem.Usage, java.nio.CharBuffer, boolean) }
4141
* @author Olivier Chafik

0 commit comments

Comments
 (0)