From 09fe9e0e41e4fd8c0ed86fac3fe13f4d88feb35f Mon Sep 17 00:00:00 2001
From: Rogiel Sulzbach <rogiel@rogiel.com>
Date: Sat, 3 Feb 2018 14:46:05 -0200
Subject: [PATCH] Improve the documentation on the binary format of arrays,
 sets and vectors

---
 include/PacketBuffer/Serializer/Std/Array.h  | 30 ++++++++++++++++++++
 include/PacketBuffer/Serializer/Std/Set.h    | 20 +++++++++++++
 include/PacketBuffer/Serializer/Std/Vector.h | 11 +++++++
 3 files changed, 61 insertions(+)

diff --git a/include/PacketBuffer/Serializer/Std/Array.h b/include/PacketBuffer/Serializer/Std/Array.h
index d8a20d4..b52e033 100644
--- a/include/PacketBuffer/Serializer/Std/Array.h
+++ b/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
 	 */
diff --git a/include/PacketBuffer/Serializer/Std/Set.h b/include/PacketBuffer/Serializer/Std/Set.h
index 7f7c547..2380de7 100644
--- a/include/PacketBuffer/Serializer/Std/Set.h
+++ b/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
diff --git a/include/PacketBuffer/Serializer/Std/Vector.h b/include/PacketBuffer/Serializer/Std/Vector.h
index 0dad2f7..29f797d 100644
--- a/include/PacketBuffer/Serializer/Std/Vector.h
+++ b/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
 	 */