Skip to content

Commit 64a948a

Browse files
committed
improved comment
1 parent 8d7f658 commit 64a948a

File tree

1 file changed

+7
-5
lines changed
  • jbbp/src/main/java/com/igormaznitsa/jbbp/mapper

1 file changed

+7
-5
lines changed

jbbp/src/main/java/com/igormaznitsa/jbbp/mapper/Bin.java

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
* case be careful and use default name and path values. The Class is not thread safe.
3535
*
3636
* <b></>Since 2.0.0 was removed prefix 'out' for fields which contained it</b>.
37+
*
3738
* @since 1.0
3839
*/
3940
@Retention(RetentionPolicy.RUNTIME)
@@ -93,27 +94,28 @@
9394
String extra() default "";
9495

9596
/**
96-
* The Value defines how many bytes are actual ones in the field, works for numeric field and arrays and allows make mapping to bit fields.The Property
97-
* works only for save and logging.
97+
* The Value defines how many bytes are actual ones in the field, works for numeric field and arrays and allows make mapping to bit fields.
9898
*
9999
* @return the number of lower bits, by default 8 bits
100100
* @see JBBPTextWriter#Bin(java.lang.Object...)
101101
* @see JBBPOut#Bin(java.lang.Object)
102102
* @see JBBPOut#Bin(java.lang.Object, com.igormaznitsa.jbbp.io.JBBPCustomFieldWriter)
103+
* @see JBBPBitNumber
103104
* @since 2.0.0
104105
*/
105106
JBBPBitNumber bitNumber() default JBBPBitNumber.BITS_8;
106107

107108
/**
108-
* Byte order to be used for write of the value.
109+
* Byte order to be used for operations.
109110
*
110-
* @return order of bytes to be used for field value write
111+
* @return order of bytes to be used
112+
* @see JBBPByteOrder
111113
* @since 2.0.0
112114
*/
113115
JBBPByteOrder byteOrder() default JBBPByteOrder.BIG_ENDIAN;
114116

115117
/**
116-
* The Value defines the field order to sort fields of the class for save or logging. If -1then it is undefined.
118+
* The Value defines the field order to show relative position in data stream. If -1then it is undefined.
117119
*
118120
* @return the outOrder of the field as number (the mapping will make ascending sorting)
119121
* @see JBBPTextWriter#Bin(java.lang.Object...)

0 commit comments

Comments
 (0)