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 Compare and using an allocator * of type Allocator. * + * @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 { * T, hash functor of type Hash, predicate of type * Predicate and using an allocator of type Allocator. * + * @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 R * using an allocator of type Allocator. * + * 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 */