express: Add docstring to DatagramIterator about Datagram lifetime

Related to #1262 [skip ci]
2022-03-01 15:13:30 +01:00 · 2022-03-01 15:13:30 +01:00 · ac3aa64d33
parent 70415af210
commit ac3aa64d33
1 changed files with 3 additions and 0 deletions
--- a/panda/src/express/datagramIterator.h
+++ b/panda/src/express/datagramIterator.h
@ -23,6 +23,9 @@
 * A class to retrieve the individual data elements previously stored in a
 * Datagram.  Elements may be retrieved one at a time; it is up to the caller
 * to know the correct type and order of each element.
+ *
+ * Note that it is the responsibility of the caller to ensure that the datagram
+ * object is not destructed while this DatagramIterator is in use.
 */
 class EXPCL_PANDA_EXPRESS DatagramIterator {
 public: