KSat/fsfw
15
4
Fork 0
forked from fsfw/fsfw
Code Issues Pull Requests 1 Releases Wiki Activity

serial fixed array list adapter doc fix

Browse Source
This commit is contained in:
Robin Müller 2020-04-18 17:12:26 +02:00
parent a7d3b4c4a0
commit e77ca55b1d
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
serialize/SerialFixedArrayListAdapter.h
View File

@ -13,16 +13,17 @@
* The sequence of objects is defined in the constructor by * The sequence of objects is defined in the constructor by
* using the setStart and setNext functions. * using the setStart and setNext functions.
* *
* 1. Buffers with a size header inside that class can be declared with * - Buffers with a size header inside that class can be declared with
* @code * @code
* SerialFixedArrayListAdapter<BUFFER_TYPE, * SerialFixedArrayListAdapter<BUFFER_TYPE,
* MAX_BUFFER_LENGTH, LENGTH_FIELD_TYPE> mySerialFixedArrayList(...). * MAX_SIZE, count_t> mySerialFixedArrayList(...).
* @endcode * @endcode
* 2. MAX_BUFFER_LENGTH specifies the maximum allowed number of elements *
* - MAX_SIZE: specifies the maximum allowed number of elements
* in FixedArrayList. * in FixedArrayList.
* 3. LENGTH_FIELD_TYPE specifies the data type of the buffer header * - BUFFER_TYPE: specifies the data type of the buffer
* containing the buffer size (defaults to 1 byte length field) * - count_t: specifies the type/size of the length field
* that follows. * which defaults to one byte.
* *
* @ingroup serialize * @ingroup serialize
*/ */