Fix doxygen documentation

diff --git a/Doxyfile b/Doxyfile
index 4a1b6f660164fc7220b7316d203d97802371d218..56d96f5d5e04d994cf36b729f831afd6bc447787 100644 (file)
--- 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 2cb9952ce7775f635b87c2b9b2511628c45ed714..235ddac971f425238a746502dd58215db3d17c2e 100644 (file)
--- 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;