stephenseo/UDPConnection
1
0
Fork 0
Code Issues Pull requests Actions Projects Releases Wiki Activity

Fix doxygen documentation

Browse source
This commit is contained in:
Stephen Seo 2020-01-13 19:22:08 +09:00
parent f0638d2d77
commit 83392fc916
2 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Doxyfile
View file

@ -102,7 +102,7 @@ WARN_NO_PARAMDOC = NO
WARN_AS_ERROR = NO WARN_AS_ERROR = NO
WARN_FORMAT = "$file:$line: $text" WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE = WARN_LOGFILE =
INPUT = "src/UDPConnection.h" INPUT = "src/UDPC.h"
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \ FILE_PATTERNS = *.c \
*.cc \ *.cc \

9
src/UDPC.h
View file

@ -1,10 +1,10 @@
/*! /*!
* \mainpage UDPConnection * \mainpage UDPConnection
* \ref UDPConnection.h * \ref UDPC.h
*/ */
/*! /*!
* \file UDPConnection.h * \file UDPC.h
* \brief Public API for UDPConnection * \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 * \brief The size in bytes of the received packet's data inside the \ref data
* array member variable. * array member variable.
* *
* If this variable is zero, then this packet is invalid, or an empty packet * UDPC does not return an empty packet when calling UDPC_get_received(), so
* was received. * in such a packet dataSize shouldn't be zero. (UDPC only stores received
* packets that do have a payload.)
*/ */
uint16_t dataSize; uint16_t dataSize;
uint16_t rtt; uint16_t rtt;