From 2e3204806f1ebe6d04f684f3c465d76c6b303c80 Mon Sep 17 00:00:00 2001 From: Ivan Pelipenko Date: Thu, 8 Oct 2020 22:42:42 +0300 Subject: [PATCH] pichunkstream.cpp documentation --- libs/main/core/pichunkstream.cpp | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/libs/main/core/pichunkstream.cpp b/libs/main/core/pichunkstream.cpp index 7920f1b4..ba6f9e4d 100644 --- a/libs/main/core/pichunkstream.cpp +++ b/libs/main/core/pichunkstream.cpp @@ -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 */