Improve the documentation on the binary format of arrays, sets and vectors

include/PacketBuffer/Serializer/Std/Array.h

@@ -44,6 +44,16 @@ namespace PacketBuffer {
 	 * when serialized. Further changing the size of the array will cause a
 	 * change in the binary format of the packet.
 	 *
+	 * Serialized data takes the format as:
+	 * @code
+	 * (
+	 * 	T: first,
+	 * 	T: second,
+	 * 	...
+	 * 	T: last
+	 * )
+	 * @endcode
+	 *
 	 * @tparam T the array type
 	 * @tparam S the array fixed size
 	 */
@@ -75,6 +85,16 @@ namespace PacketBuffer {
 	 * when serialized. Further changing the size of the array will cause a
 	 * change in the binary format of the packet.
 	 *
+	 * Serialized data takes the format as:
+	 * @code
+	 * (
+	 * 	T: first,
+	 * 	T: second,
+	 * 	...
+	 * 	T: last
+	 * )
+	 * @endcode
+	 *
 	 * @tparam T the array type
 	 * @tparam S the array fixed size
 	 */
@@ -100,6 +120,16 @@ namespace PacketBuffer {
 	 * when serialized. Further changing the size of the array will cause a
 	 * change in the binary format of the packet.
 	 *
+	 * Serialized data takes the format as:
+	 * @code
+	 * (
+	 * 	T: first,
+	 * 	T: second,
+	 * 	...
+	 * 	T: last
+	 * )
+	 * @endcode
+	 *
 	 * @tparam T the array type
 	 * @tparam S the array fixed size
 	 */

include/PacketBuffer/Serializer/Std/Set.h

@@ -42,6 +42,16 @@ namespace PacketBuffer {
 	 * comparison functor of type <tt>Compare</tt> and using an allocator
 	 * of type <tt>Allocator</tt>.
 	 *
+	 * @code
+	 * (
+	 * 	uint64_t: 	size
+	 * 	T: 			element[0]
+	 * 	T: 			element[1]
+	 * 	...
+	 * 	T: 			element[size-1]
+	 * )
+	 * @endcode
+	 *
 	 * @tparam T         the set element key
 	 * @tparam Compare   the set comparison functor
 	 * @tparam Allocator the set allocator type
@@ -76,6 +86,16 @@ namespace PacketBuffer {
 	 * <tt>T</tt>, hash functor of type <tt>Hash</tt>, predicate of type
 	 * <tt>Predicate</tt> and using an allocator of type <tt>Allocator</tt>.
 	 *
+	 * @code
+	 * (
+	 * 	uint64_t: 	size
+	 * 	T: 			element[0]
+	 * 	T: 			element[1]
+	 * 	...
+	 * 	T: 			element[size-1]
+	 * )
+	 * @endcode
+	 *
 	 * @tparam T         the set element key
 	 * @tparam Hash      the set hash functor
 	 * @tparam Predicate the set predicate functor

include/PacketBuffer/Serializer/Std/Vector.h

@@ -40,6 +40,17 @@ namespace PacketBuffer {
 	 * A ObjectSerializer for std::vector with elements of type <tt>R</tt>
 	 * using an allocator of type <tt>Allocator</tt>.
 	 *
+	 * Serialized data takes the format as:
+	 * @code
+	 * (
+	 * 	uint64_t: 	size
+	 * 	T: 			element[0]
+	 * 	T: 			element[1]
+	 * 	...
+	 * 	T: 			element[size-1]
+	 * )
+	 * @endcode
+	 *
 	 * @tparam T         the vector element type
 	 * @tparam Allocator the vector allocator type
 	 */