Skip to content

Commit 84e447e

Browse files
committed
Fix javadoc
1 parent 652f338 commit 84e447e

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

src/main/java/fr/devnied/bitlib/BitUtils.java

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ public boolean getNextBoolean() {
150150
}
151151

152152
/**
153-
* Method used to get the next byte and shift read data to the beginning of the array.<br/>
153+
* Method used to get the next byte and shift read data to the beginning of the array.<br>
154154
* (Ex 00110000b if we start read 2 bit at index 2 the data returned will be 11000000b)
155155
*
156156
* @param pSize
@@ -167,7 +167,7 @@ public byte[] getNextByte(final int pSize) {
167167
* @param pSize
168168
* the size in bit to read
169169
* @param pShift
170-
* boolean to indicate if the data read will be shift to the left.<br/>
170+
* boolean to indicate if the data read will be shift to the left.<br>
171171
* <ul>
172172
* <li>if true : (Ex 10110000b if we start read 2 bit at index 2 the returned data will be 11000000b)</li>
173173
* <li>if false : (Ex 10110000b if we start read 2 bit at index 2 the returned data will be 00110000b)</li>
@@ -339,7 +339,7 @@ public String getNextString(final int pSize) {
339339
*
340340
* @param pSize
341341
* the length of the string int bit
342-
* @param pChartset
342+
* @param pCharset
343343
* the charset
344344
* @return the string
345345
*/
@@ -422,6 +422,8 @@ public void setNextByte(final byte[] pValue, final int pLength) {
422422
* the value to write
423423
* @param pLength
424424
* the length of the data in bits
425+
* @param pPadBefore
426+
* if true pad with 0
425427
*/
426428
public void setNextByte(final byte[] pValue, final int pLength, final boolean pPadBefore) {
427429
int totalSize = (int) Math.ceil(pLength / BYTE_SIZE_F);
@@ -514,6 +516,9 @@ public void setNextHexaString(final String pValue, final int pLength) {
514516
*
515517
* Be careful with java long bit sign
516518
*
519+
* @param pValue
520+
* the value to set
521+
*
517522
* @param pLength
518523
* the length of the long
519524
*/
@@ -590,7 +595,7 @@ public void setNextString(final String pValue, final int pLength) {
590595
*
591596
* @param pValue
592597
* the string to write
593-
* @param pLenth
598+
* @param pLength
594599
* the string length
595600
* @param pPaddedBefore
596601
* indicate if the string is padded before or after

src/main/java/fr/devnied/bitlib/BytesUtils.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ public static int byteArrayToInt(final byte[] byteArray, final int startPos, fin
8080
/**
8181
* Method to convert bytes to string with space between bytes
8282
*
83-
* bytes to convert
83+
* @param pBytes
84+
* Bytes to convert
8485
*
8586
* @return a string
8687
*/
@@ -92,7 +93,8 @@ public static String bytesToString(final byte[] pBytes) {
9293
* Method to convert bytes to string with space between bytes
9394
*
9495
* bytes to convert
95-
*
96+
* @param pBytes
97+
* Bytes to convert
9698
* @param pTruncate
9799
* true to remove 0 left byte value
98100
* @return a string
@@ -206,7 +208,7 @@ public static boolean matchBitByBitIndex(final int pVal, final int pBitIndex) {
206208
/**
207209
* Method used to set a bit index to 1 or 0.
208210
*
209-
* @param data
211+
* @param pData
210212
* data to modify
211213
* @param pBitIndex
212214
* index to set

0 commit comments

Comments
 (0)