kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

include/ruby/vm.h: add doxygen

Browse source 
Must not be a bad idea to improve documents. [ci skip]
This commit is contained in:
卜部昌平 2021-06-08 09:55:09 +09:00
parent ba814a5aa3
commit 072d74cc7a
Notes: git 2021-09-10 20:01:13 +09:00
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
include/ruby/vm.h
View file

@ -9,21 +9,26 @@
* Permission is hereby granted, to either redistribute and/or * Permission is hereby granted, to either redistribute and/or
* modify this file, provided that the conditions mentioned in the * modify this file, provided that the conditions mentioned in the
* file COPYING are met. Consult the file for details. * 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" #include "ruby/internal/dllexport.h"
RBIMPL_SYMBOL_EXPORT_BEGIN() RBIMPL_SYMBOL_EXPORT_BEGIN()
/* Place holder. /**
* * The opaque struct to hold VM internals. Its fields are intentionally hidden
* We will prepare VM creation/control APIs on 1.9.2 or later. * from extension libraries because it changes drastically time to time.
*
*/ */
/* VM type declaration */
typedef struct rb_vm_struct ruby_vm_t; 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); int ruby_vm_destruct(ruby_vm_t *vm);
/** /**