From 7b230bc8486e7d451113c3c0301adcecfc09b893 Mon Sep 17 00:00:00 2001
From: Peter Zhu <peter@peterzhu.ca>
Date: Mon, 10 Apr 2023 17:09:13 -0400
Subject: [DOC] Documentation for flags of RObject

---
 object.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'object.c')

diff --git a/object.c b/object.c
index 24cbdd516f..94e85ed316 100644
--- a/object.c
+++ b/object.c
@@ -42,6 +42,18 @@
 #include "builtin.h"
 #include "shape.h"
 
+/* Flags of RObject
+ *
+ * 1:    ROBJECT_EMBED
+ *           The object has its instance variables embedded (the array of
+ *           instance variables directly follow the object, rather than being
+ *           on a separately allocated buffer).
+ * if !SHAPE_IN_BASIC_FLAGS
+ * 4-19: SHAPE_FLAG_MASK
+ *           Shape ID for the object.
+ * endif
+ */
+
 /*!
  * \addtogroup object
  * \{
-- 
cgit v1.2.1