Fix doxygen documentation
This commit is contained in:
parent
f0638d2d77
commit
83392fc916
2 changed files with 6 additions and 5 deletions
2
Doxyfile
2
Doxyfile
|
@ -102,7 +102,7 @@ WARN_NO_PARAMDOC = NO
|
|||
WARN_AS_ERROR = NO
|
||||
WARN_FORMAT = "$file:$line: $text"
|
||||
WARN_LOGFILE =
|
||||
INPUT = "src/UDPConnection.h"
|
||||
INPUT = "src/UDPC.h"
|
||||
INPUT_ENCODING = UTF-8
|
||||
FILE_PATTERNS = *.c \
|
||||
*.cc \
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
/*!
|
||||
* \mainpage UDPConnection
|
||||
* \ref UDPConnection.h
|
||||
* \ref UDPC.h
|
||||
*/
|
||||
|
||||
/*!
|
||||
* \file UDPConnection.h
|
||||
* \file UDPC.h
|
||||
* \brief Public API for UDPConnection
|
||||
*/
|
||||
|
||||
|
@ -171,8 +171,9 @@ typedef struct {
|
|||
* \brief The size in bytes of the received packet's data inside the \ref data
|
||||
* array member variable.
|
||||
*
|
||||
* If this variable is zero, then this packet is invalid, or an empty packet
|
||||
* was received.
|
||||
* UDPC does not return an empty packet when calling UDPC_get_received(), so
|
||||
* in such a packet dataSize shouldn't be zero. (UDPC only stores received
|
||||
* packets that do have a payload.)
|
||||
*/
|
||||
uint16_t dataSize;
|
||||
uint16_t rtt;
|
||||
|
|
Loading…
Reference in a new issue