From 3bd3a05dbda8abb64759f1a41f9a508a62faf6ef Mon Sep 17 00:00:00 2001 From: Tim Besard Date: Mon, 21 Nov 2011 11:09:43 +0100 Subject: Adding documentation to Chain type. --- src/chain.h | 7 +++++++ 1 file changed, 7 insertions(+) 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; }; -- cgit v1.2.3