From 99c3328edc696ec3ce12d536a1dfe4578fd26f13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=8D=9C=E9=83=A8=E6=98=8C=E5=B9=B3?= Date: Wed, 9 Dec 2020 17:00:50 +0900 Subject: [PATCH] include/ruby/internal/error.h: name a parameter Better document [ci skip] --- include/ruby/internal/error.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/include/ruby/internal/error.h b/include/ruby/internal/error.h index fa7fb1748b..49e2276cb9 100644 --- a/include/ruby/internal/error.h +++ b/include/ruby/internal/error.h @@ -74,13 +74,14 @@ VALUE rb_errinfo(void); /** * 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 * ::RUBY_Qnil. * @note Use rb_raise() instead to raise `err`. This function just * assigns the given object to the global variable. * @ingroup exception */ -void rb_set_errinfo(VALUE); +void rb_set_errinfo(VALUE err); RBIMPL_ATTR_NORETURN() RBIMPL_ATTR_NONNULL((2)) @@ -151,7 +152,7 @@ RBIMPL_ATTR_NORETURN() /** * Converts a C errno into a Ruby exception, then raises it. For instance: * - * ```C + * ```CXX * static VALUE * foo(VALUE argv) * {