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/internal/error.h: name a parameter

Browse source 
Better document [ci skip]
This commit is contained in:
卜部昌平 2020-12-09 17:00:50 +09:00
parent 891dbedd00
commit 99c3328edc
Notes: git 2021-09-10 20:01:48 +09:00
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
include/ruby/internal/error.h
View file

@ -74,13 +74,14 @@ VALUE rb_errinfo(void);
/** /**
* Sets the current exception (`$!`) to the given value. * Sets the current exception (`$!`) to the given value.
* *
* @param[in] err An instance of ::rb_eException, or ::RUBY_Qnil.
* @exception rb_eTypeError What is given was neither ::rb_eException nor * @exception rb_eTypeError What is given was neither ::rb_eException nor
* ::RUBY_Qnil. * ::RUBY_Qnil.
* @note Use rb_raise() instead to raise `err`. This function just * @note Use rb_raise() instead to raise `err`. This function just
* assigns the given object to the global variable. * assigns the given object to the global variable.
* @ingroup exception * @ingroup exception
*/ */
void rb_set_errinfo(VALUE); void rb_set_errinfo(VALUE err);
RBIMPL_ATTR_NORETURN() RBIMPL_ATTR_NORETURN()
RBIMPL_ATTR_NONNULL((2)) RBIMPL_ATTR_NONNULL((2))
@ -151,7 +152,7 @@ RBIMPL_ATTR_NORETURN()
/** /**
* Converts a C errno into a Ruby exception, then raises it. For instance: * Converts a C errno into a Ruby exception, then raises it. For instance:
* *
* ```C * ```CXX
* static VALUE * static VALUE
* foo(VALUE argv) * foo(VALUE argv)
* { * {