From 1bb0749c5ba4b730304ca0cf37701e654fa06759 Mon Sep 17 00:00:00 2001
From: Nobuyoshi Nakada <nobu@ruby-lang.org>
Date: Wed, 4 Jan 2023 00:06:54 +0900
Subject: [DOC] Move the internal document for `Init_class_hierarchy`

It has hidden the document for `Object` class.
---
 class.c | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'class.c')

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)
 {
-- 
cgit v1.2.1