SergeychWorks/mp_bintools
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 4 Wiki Activity

dokka docs added/2

Browse Source
This commit is contained in:
Sergey Chernov 2023-03-15 23:09:51 +01:00
parent 61c0b7b0f8
commit eb25bcb94e
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/bipack.md
View File

@ -8,7 +8,7 @@ This library contains a `Bipack` binary format serializer, see [net.sergeych.bip
Bipack ais a common kotlinx serializer that works pretty much like any other `kotlinx.serialization` format. You just mark your class as `@Serializable` and it does the rest.
- [BipackEncoder] to serializes anything to bipack format.
- [BpackDecoder] deserializes from bipack back.
- [BipackDecoder] deserializes from bipack back.
There are also special annotation to fine tune the format: [Extendable], [Framed], [CrcProtected] for classes and [Unsigned] for integer data fields.