30.11.2013 - New PICollection namespace, Android support, my own PIVector implementation

pibytearray.cpp

@@ -25,7 +25,7 @@
  * to manipulate it.
  * 
  * \section PIByteArray_sec0 Usage
- * PIByteArray can be used to store custom data and manipulate it. There are many
+ * %PIByteArray can be used to store custom data and manipulate it. There are many
  * stream operators to store/restore common types to byte array. Store operators
  * places data at the end of arraym restore operators takes data from the beginning
  * of array.
@@ -36,6 +36,26 @@
  * * CRC 16-bit
  * * CRC 32-bit
  * 
+ * One of the major usage of %PIByteArray is stream functions. You can form binary
+ * packet from many types (also dynamic types, e.g. PIVector) with one line:
+ * \snippet pibytearray.cpp 0
+ * 
+ * Or you can descibe stream operator of your own type and store/restore vectors of
+ * your type:
+ * \snippet pibytearray.cpp 1
+ * 
+ * For store/restore custom data blocks there is PIByteArray::RawData class. Stream
+ * operators of this class simply store/restore data block to/from byte array.
+ * \snippet pibytearray.cpp 2
+ * 
+ * \section PIByteArray_sec1 Attention
+ * Stream operator of %PIByteArray store byte array as vector, not simply append
+ * content of byte array. This operators useful to transmit custom data as %PIByteArray
+ * packed into parent byte array, e.g. to form packet from %PIByteArray.
+ * To append one byte array to another use funtion \a append().
+ * \snippet pibytearray.cpp 3
+ * 
+ * 
  */