vm.c: add a simple rdoc for RubyVM

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@64404 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 7 insertions, 1 deletions

diff --git a/vm.c b/vm.c
index 77f0276057..b43a30e808 100644
--- a/vm.c
+++ b/vm.c
@@ -2842,7 +2842,13 @@ Init_VM(void)
     VALUE fcore;
     VALUE mjit;
 
-    /* ::RubyVM */
+    /*
+     * Document-class: RubyVM
+     *
+     * RubyVM module provides some access to Ruby internal.
+     * This module is for very limited purpose, such as debugging,
+     * prototyping, and research.  Normal users must not use it.
+     */
     rb_cRubyVM = rb_define_class("RubyVM", rb_cObject);
     rb_undef_alloc_func(rb_cRubyVM);
     rb_undef_method(CLASS_OF(rb_cRubyVM), "new");