Skip to content

Commit

Permalink
update: clear javadoc warning
Browse files Browse the repository at this point in the history
  • Loading branch information
gc-garcol committed Nov 23, 2024
1 parent 66f1fea commit 339fe19
Show file tree
Hide file tree
Showing 10 changed files with 57 additions and 3 deletions.
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ plugins {
}

group = "io.github.gc-garcol"
version = "1.0.0"
version = "1.0.1"

java {
withJavadocJar()
Expand Down
2 changes: 1 addition & 1 deletion lib-core/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ plugins {
}

group = "io.github.gc-garcol"
version = "1.0.0"
version = "1.0.1"

java {
toolchain {
Expand Down
8 changes: 8 additions & 0 deletions lib-core/src/main/java/gc/garcol/libcore/BitUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
*/
public class BitUtil
{

/**
* Private constructor to prevent instantiation.
*/
private BitUtil()
{
}

/**
* <p>
* Align a value to the next multiple up of alignment.
Expand Down
7 changes: 7 additions & 0 deletions lib-core/src/main/java/gc/garcol/libcore/BufferUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@
public class BufferUtil
{

/**
* Private constructor to prevent instantiation.
*/
private BufferUtil()
{
}

/**
* The base offset of the byte array in memory.
* Used for calculating the memory address of array elements.
Expand Down
8 changes: 8 additions & 0 deletions lib-core/src/main/java/gc/garcol/libcore/ByteBufferUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@
*/
public class ByteBufferUtil
{

/**
* Private constructor to prevent instantiation.
*/
private ByteBufferUtil()
{
}

/**
* Puts the given byte array into the specified ByteBuffer at the given index.
* Updates the buffer's position to the end of the inserted data.
Expand Down
8 changes: 8 additions & 0 deletions lib-core/src/main/java/gc/garcol/libcore/MemoryAccess.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@
*/
public class MemoryAccess
{

/**
* Private constructor to prevent instantiation.
*/
private MemoryAccess()
{
}

/**
* Ensures that all previous loads are visible to subsequent loads.
* This method uses Unsafe's loadFence to provide the memory fence.
Expand Down
8 changes: 8 additions & 0 deletions lib-core/src/main/java/gc/garcol/libcore/Preconditions.java
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@
*/
public class Preconditions
{

/**
* Private constructor to prevent instantiation.
*/
private Preconditions()
{
}

/**
* Checks if the provided argument condition is true.
* Throws an IllegalArgumentException with the specified message if the condition is false.
Expand Down
8 changes: 8 additions & 0 deletions lib-core/src/main/java/gc/garcol/libcore/RingBufferUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@
*/
public class RingBufferUtil
{

/**
* Private constructor to prevent instantiation.
*/
private RingBufferUtil()
{
}

/**
* Checks if the message length is within the valid range.
*
Expand Down
2 changes: 1 addition & 1 deletion lib-core/src/main/java/gc/garcol/libcore/UnsafeBuffer.java
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
* @author thaivc
* @since 2024
*/
@SuppressWarnings("javadoc")
public class UnsafeBuffer
{

private final byte[] buffer;

/**
Expand Down
7 changes: 7 additions & 0 deletions lib-core/src/main/java/gc/garcol/libcore/UnsafeHelper.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ public class UnsafeHelper
{
static final Unsafe UNSAFE;

/**
* Private constructor to prevent instantiation.
*/
private UnsafeHelper()
{
}

static
{
try
Expand Down

0 comments on commit 339fe19

Please sign in to comment.