Skip to content

Commit d480778

Browse files
committed
improved description
1 parent 0f67814 commit d480778

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,18 +109,26 @@ The Example will print in console the text below
109109
```
110110
Fields
111111
==================
112+
Every field can have case insensitive name which should not contain '.' (because it is reserved for links to structure field values) and '#'(because it is also reserver for inside usage).
113+
Field name must not be started by a number or chars '$' and '_'. *Field names are case insensitive!*
114+
```
115+
int someNamedField;
116+
byte field1;
117+
byte field2;
118+
byte field3;
119+
```
112120
![JBBP field format, types and examples](https://github.com/raydac/java-binary-block-parser/blob/master/docs/jbbp_fields.png)
113121

114-
#Primitive types
122+
##Primitive types
115123
The Framework supports full set of Java numeric primitives with extra types like ubyte and bit.
116124
![JBBP field format, types and examples](https://github.com/raydac/java-binary-block-parser/blob/master/docs/jbbp_primitives.png)
117-
#Complex types
125+
##Complex types
118126
The Framework provides support for arrays and structures. Just keep in mind that in expressions you can make links to field values only defined before expression.
119127
![JBBP field format, types and examples](https://github.com/raydac/java-binary-block-parser/blob/master/docs/jbbp_complex_types.png)
120-
#Special types
128+
##Special types
121129
Special types makes some actions to skip data in input stream
122130
![JBBP field format, types and examples](https://github.com/raydac/java-binary-block-parser/blob/master/docs/jbbp_special_fields.png)
123-
#Byte order
131+
##Byte order
124132
Every multi-byte type can be read with different byte order.
125133
![JBBP field format, types and examples](https://github.com/raydac/java-binary-block-parser/blob/master/docs/jbbp_byteorder.png)
126134

@@ -141,10 +149,6 @@ int field1;
141149
byte [field1+struct1.field2] data;
142150
```
143151

144-
Field names
145-
============
146-
You can use any chars for field names but you can't use '.' in names (because the special char is used as the separator in field paths) and a name must not be started with a number. Also you must not use the symbols '$' and '_' as the first char in the name because they are used by the parser for special purposes.
147-
148152
Commentaries
149153
=============
150154
You can use commentaries inside a parser script, the parser supports the only comment format and recognizes as commentaries all text after '//' till the end of line.

0 commit comments

Comments
 (0)