diff options
| author | 卜部昌平 <shyouhei@ruby-lang.org> | 2020-12-09 17:00:50 +0900 |
|---|---|---|
| committer | 卜部昌平 <shyouhei@ruby-lang.org> | 2021-09-10 20:00:06 +0900 |
| commit | 99c3328edc696ec3ce12d536a1dfe4578fd26f13 (patch) | |
| tree | 8bef54dabf282694540d8c0ad05d2aded0a881b0 /include/ruby/internal/error.h | |
| parent | 891dbedd001720442167b8bbeee0edf11c3e58de (diff) | |
include/ruby/internal/error.h: name a parameter
Better document [ci skip]
Notes
Notes:
Merged: https://github.com/ruby/ruby/pull/4815
Diffstat (limited to 'include/ruby/internal/error.h')
| -rw-r--r-- | include/ruby/internal/error.h | 5 |
1 files 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) * { |