summaryrefslogtreecommitdiff
path: root/class.c
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2023-01-04 00:06:54 +0900
committerNobuyoshi Nakada <nobu@ruby-lang.org>2023-01-04 01:18:24 +0900
commit1bb0749c5ba4b730304ca0cf37701e654fa06759 (patch)
tree050f2782478539e497765313c2d77d80463ce5aa /class.c
parent59cf9ebf4dc211cb9d71a484866895b3d927fbe6 (diff)
downloadruby-1bb0749c5ba4b730304ca0cf37701e654fa06759.tar.gz
[DOC] Move the internal document for `Init_class_hierarchy`
It has hidden the document for `Object` class.
Diffstat (limited to 'class.c')
-rw-r--r--class.c21
1 files changed, 21 insertions, 0 deletions
diff --git a/class.c b/class.c
index 847c4d0a57..333a9d78e5 100644
--- a/class.c
+++ b/class.c
@@ -803,6 +803,27 @@ refinement_import_methods(int argc, VALUE *argv, VALUE refinement)
}
# endif
+/*!
+ *--
+ * \private
+ * Initializes the world of objects and classes.
+ *
+ * At first, the function bootstraps the class hierarchy.
+ * It initializes the most fundamental classes and their metaclasses.
+ * - \c BasicObject
+ * - \c Object
+ * - \c Module
+ * - \c Class
+ * After the bootstrap step, the class hierarchy becomes as the following
+ * diagram.
+ *
+ * \image html boottime-classes.png
+ *
+ * Then, the function defines classes, modules and methods as usual.
+ * \ingroup class
+ *++
+ */
+
void
Init_class_hierarchy(void)
{