pichunkstream.cpp documentation

This commit is contained in:
2020-10-08 22:42:42 +03:00
parent 16cfdc709b
commit 2e3204806f

View File

@@ -41,13 +41,22 @@
* but you should definitely know type of this value. You can read from byte array
* while \a atEnd() if false.
*
* \section PIChunkStream_ex0 Example
* Prepare your structs to work with %PIChunkStream
* \section PIChunkStream_sec2 Examples
*
* Using simple operator and cascade serialization:
*
* Prepare your structs to work with %PIChunkStream:
* \snippet pichunkstream.cpp struct
* Writing to %PIChunkStream
* Old-style writing to %PIChunkStream:
* \snippet pichunkstream.cpp write
* Reading from %PIChunkStream
* Fastest reading from %PIChunkStream:
* \snippet pichunkstream.cpp read
*
* And next code show how to serialize your struct with %PIChunkStream:
* \snippet pichunkstream.cpp write_new
*
* ... and deserialize:
* \snippet pichunkstream.cpp read_new
*/