From 4e792ffa7d9954ab091306688294306c3aebe4fb Mon Sep 17 00:00:00 2001
From: yugui <yugui@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Mon, 29 Jun 2009 16:39:28 +0000
Subject: Doxy-comments.

git-svn-id: http://svn.ruby-lang.org/repos/ruby/trunk@23902 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 object.c | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

(limited to 'object.c')

diff --git a/object.c b/object.c
index db5f41832..0458ccf4b 100644
--- a/object.c
+++ b/object.c
@@ -2449,7 +2449,24 @@ boot_defmetametaclass(VALUE klass, VALUE metametaclass)
  */
 
 
-/*
+/*!
+ *--
+ * 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
+ *++
  *  <code>BasicObject</code> is the parent class of all classes in Ruby.
  *  It's an explicit blank class.  <code>Object</code>, the root of Ruby's
  *  class hierarchy is a direct subclass of <code>BasicObject</code>.  Its
-- 
cgit