summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Besard <tim.besard@gmail.com>2011-11-21 11:09:43 +0100
committerTim Besard <tim.besard@gmail.com>2011-11-21 11:09:43 +0100
commit3bd3a05dbda8abb64759f1a41f9a508a62faf6ef (patch)
tree07b46eceda6727730d779b920771beefab7d1153
parent2cca0b120b7d8bd6c429430a97333c86d9784763 (diff)
Adding documentation to Chain type.
-rw-r--r--src/chain.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/chain.h b/src/chain.h
index d33fa2d..ee3d36a 100644
--- a/src/chain.h
+++ b/src/chain.h
@@ -23,6 +23,13 @@
// Struct definition
//
+/*
+ * Note that the Chain object should always be a Plain Old Data (POD) object,
+ * because it is used from within JIT-generated assembly code, so we need to
+ * be able to refer to its data members using the C macro offsetof. This is
+ * only possible in case of a POD object.
+ */
+
struct Chain {
Chain* next;
};