Clarifying 'Recevier::readPacket' docs to state that the packet stats…

… are filled in regardless of the function's return value.
ssilverman · Dec 3, 2019 · 8585992 · 8585992
1 parent 893e131
commit 8585992
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/src/TeensyDMX.h b/src/TeensyDMX.h
@@ -292,8 +292,9 @@ class Receiver final : public TeensyDMX {
   // been stopped.
   //
   // If the optional parameter, `stats`, is set to non-NULL, then the latest
-  // packet statistics are stored in that object. The values are read atomically
-  // with the latest packet data. This is an advantage over 'packetStats()`.
+  // packet statistics are stored in that object, regardless of this function's
+  // return value. The values are read atomically with the latest packet data.
+  // This is an advantage over 'packetStats()`.
   int readPacket(uint8_t *buf, int startChannel, int len,
                  PacketStats *stats = nullptr);