From: Stephen Seo <seo.disparate@gmail.com>
Date: Mon, 13 Jan 2020 10:22:08 +0000 (+0900)
Subject: Fix doxygen documentation
X-Git-Tag: 1.0~78
X-Git-Url: https://git.seodisparate.com/stephenseo/search/main.js?a=commitdiff_plain;h=83392fc9163dad6ad4267594b95f0f51f0b23fc7;p=UDPConnection

Fix doxygen documentation
---

diff --git a/Doxyfile b/Doxyfile
index 4a1b6f6..56d96f5 100644
--- a/Doxyfile
+++ b/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 \
diff --git a/src/UDPC.h b/src/UDPC.h
index 2cb9952..235ddac 100644
--- a/src/UDPC.h
+++ b/src/UDPC.h
@@ -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;