changeset 96:f2b65c8f6a24

types: Clarify that yref_t shouldn't be copied but cloned instead
author Lewin Bormann <lbo@spheniscida.de>
date Mon, 26 Aug 2019 17:00:47 +0200
parents 4967652fcbf5
children 3b468dad363f
files src/types.h
diffstat 1 files changed, 4 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/src/types.h	Mon Aug 26 17:00:25 2019 +0200
+++ b/src/types.h	Mon Aug 26 17:00:47 2019 +0200
@@ -28,8 +28,10 @@
 } YREF_TYPE;
 
 /**
- * @brief A reference to a stored function or value. To be used as value (not
- * pointer).
+ * @brief A reference to a stored function or value. To be used as pointer.
+ *
+ * yref_t values should not be copied around freely, as the string in the
+ * `ref.sym` field may only be freed once.
  */
 typedef struct {
     /// The reference.