From e77ca55b1d383afd0079152a4d6809d3e79a6a93 Mon Sep 17 00:00:00 2001 From: "Robin.Mueller" Date: Sat, 18 Apr 2020 17:12:26 +0200 Subject: [PATCH] serial fixed array list adapter doc fix --- serialize/SerialFixedArrayListAdapter.h | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/serialize/SerialFixedArrayListAdapter.h b/serialize/SerialFixedArrayListAdapter.h index 6e13ff6f4..841e9b7aa 100644 --- a/serialize/SerialFixedArrayListAdapter.h +++ b/serialize/SerialFixedArrayListAdapter.h @@ -13,16 +13,17 @@ * The sequence of objects is defined in the constructor by * using the setStart and setNext functions. * - * 1. Buffers with a size header inside that class can be declared with - * @code - * SerialFixedArrayListAdapter mySerialFixedArrayList(...). - * @endcode - * 2. MAX_BUFFER_LENGTH specifies the maximum allowed number of elements - * in FixedArrayList. - * 3. LENGTH_FIELD_TYPE specifies the data type of the buffer header - * containing the buffer size (defaults to 1 byte length field) - * that follows. + * - Buffers with a size header inside that class can be declared with + * @code + * SerialFixedArrayListAdapter mySerialFixedArrayList(...). + * @endcode + * + * - MAX_SIZE: specifies the maximum allowed number of elements + * in FixedArrayList. + * - BUFFER_TYPE: specifies the data type of the buffer + * - count_t: specifies the type/size of the length field + * which defaults to one byte. * * @ingroup serialize */