From 9ba9dbf168c8be042a11baad90a2b7bf8428a478 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=8D=9C=E9=83=A8=E6=98=8C=E5=B9=B3?=
 <shyouhei@ruby-lang.org>
Date: Mon, 21 Dec 2020 16:32:40 +0900
Subject: include/ruby/internal/module.h: add doxygen

Must not be a bad idea to improve documents. [ci skip]

In fact many functions declared in the header file are already
documented more or less.  They were just copy & pasted, with applying
some style updates.
---
 class.c | 52 +---------------------------------------------------
 1 file changed, 1 insertion(+), 51 deletions(-)

(limited to 'class.c')

diff --git a/class.c b/class.c
index b25e961b27..35f9b862ff 100644
--- a/class.c
+++ b/class.c
@@ -10,16 +10,7 @@
 **********************************************************************/
 
 /*!
- * \defgroup class Classes and their hierarchy.
- * \par Terminology
- * - class: same as in Ruby.
- * - singleton class: class for a particular object
- * - eigenclass: = singleton class
- * - metaclass: class of a class. metaclass is a kind of singleton class.
- * - metametaclass: class of a metaclass.
- * - meta^(n)-class: class of a meta^(n-1)-class.
- * - attached object: A singleton class knows its unique instance.
- *   The instance is called the attached object for the singleton class.
+ * \addtogroup class
  * \{
  */
 
@@ -734,23 +725,6 @@ rb_class_inherited(VALUE super, VALUE klass)
     return rb_funcall(super, inherited, 1, klass);
 }
 
-
-
-/*!
- * Defines a top-level class.
- * \param name   name of the class
- * \param super  a class from which the new class will derive.
- * \return the created class
- * \throw TypeError if the constant name \a name is already taken but
- *                  the constant is not a \c Class.
- * \throw TypeError if the class is already defined but the class can not
- *                  be reopened because its superclass is not \a super.
- * \throw ArgumentError if the \a super is NULL.
- * \post top-level constant named \a name refers the returned class.
- *
- * \note if a class named \a name is already defined and its superclass is
- *       \a super, the function just returns the defined class.
- */
 VALUE
 rb_define_class(const char *name, VALUE super)
 {
@@ -783,24 +757,6 @@ rb_define_class(const char *name, VALUE super)
     return klass;
 }
 
-
-/*!
- * Defines a class under the namespace of \a outer.
- * \param outer  a class which contains the new class.
- * \param name   name of the new class
- * \param super  a class from which the new class will derive.
- *               NULL means \c Object class.
- * \return the created class
- * \throw TypeError if the constant name \a name is already taken but
- *                  the constant is not a \c Class.
- * \throw TypeError if the class is already defined but the class can not
- *                  be reopened because its superclass is not \a super.
- * \post top-level constant named \a name refers the returned class.
- *
- * \note if a class named \a name is already defined and its superclass is
- *       \a super, the function just returns the defined class.
- * \note the compaction GC does not move classes returned by this function.
- */
 VALUE
 rb_define_class_under(VALUE outer, const char *name, VALUE super)
 {
@@ -876,9 +832,6 @@ rb_define_module_id(ID id)
     return rb_module_new();
 }
 
-/*!
- * \note the compaction GC does not move modules returned by this function.
- */
 VALUE
 rb_define_module(const char *name)
 {
@@ -903,9 +856,6 @@ rb_define_module(const char *name)
     return module;
 }
 
-/*!
- * \note the compaction GC does not move modules returned by this function.
- */
 VALUE
 rb_define_module_under(VALUE outer, const char *name)
 {
-- 
cgit v1.2.3