https://git.ruby-lang.org/ruby.git/commit/?id=072d74cc7a

From 072d74cc7aa710cf1d8e42c661bdf6c84ead1c82 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=8D=9C=E9=83=A8=E6=98=8C=E5=B9=B3?=
 <shyouhei@r...>
Date: Tue, 8 Jun 2021 09:55:09 +0900
Subject: include/ruby/vm.h: add doxygen

Must not be a bad idea to improve documents. [ci skip]
---
 include/ruby/vm.h | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/include/ruby/vm.h b/include/ruby/vm.h
index 7bdd567..3458c28 100644
--- a/include/ruby/vm.h
+++ b/include/ruby/vm.h
@@ -9,21 +9,26 @@ https://github.com/ruby/ruby/blob/trunk/include/ruby/vm.h#L9
  *             Permission  is hereby  granted,  to  either redistribute  and/or
  *             modify this file, provided that  the conditions mentioned in the
  *             file COPYING are met.  Consult the file for details.
+ *
+ * We  planned to  have multiple  VMs  run side-by-side.   The API  here was  a
+ * preparation of that feature.  The topic branch was eventually abandoned, and
+ * we now have Ractor.  This file is kind of obsolescent.
  */
 #include "ruby/internal/dllexport.h"
 
 RBIMPL_SYMBOL_EXPORT_BEGIN()
 
-/* Place holder.
- *
- * We will prepare VM creation/control APIs on 1.9.2 or later.
- *
+/**
+ * The opaque struct to hold VM internals.  Its fields are intentionally hidden
+ * from extension libraries because it changes drastically time to time.
  */
-
-/* VM type declaration */
 typedef struct rb_vm_struct ruby_vm_t;
 
-/* core API */
+/**
+ * Destructs the  passed VM.   You don't  have to call  this API  directly now,
+ * because there is  no way to create one.   There is only one VM  at one time.
+ * ruby_stop() should just suffice.
+ */
 int ruby_vm_destruct(ruby_vm_t *vm);
 
 /**
-- 
cgit v1.1


--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/