From 905d52772cae8d91ba09e8446a726649335247f9 Mon Sep 17 00:00:00 2001 From: eregon Date: Tue, 25 Apr 2017 09:10:46 +0000 Subject: Document the Warning module and warn method * error.c (Warning): add documentation. [Feature #13504] Author: Jeremy Evans git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58472 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- error.c | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'error.c') diff --git a/error.c b/error.c index 45106de851..0ca6544bac 100644 --- a/error.c +++ b/error.c @@ -136,6 +136,15 @@ ruby_deprecated_internal_feature(const char *func) rb_fatal("%s is only for internal use and deprecated; do not use", func); } +/* + * call-seq: + * warn(msg) -> nil + * + * Writes warning message to $stderr, followed by a newline + * if the message does not end in a newline. This method is called + * by ruby for all emitted warnings. + */ + static VALUE rb_warning_s_warn(VALUE mod, VALUE str) { @@ -145,6 +154,22 @@ rb_warning_s_warn(VALUE mod, VALUE str) return Qnil; } +/* + * Document-module: Warning + * + * The Warning module contains a single method named #warn, and the + * module extends itself, making Warning.warn available. + * Warning.warn is called for all warnings issued by ruby. + * By default, warnings are printed to $stderr. + * + * By overriding Warning.warn, you can change how warnings are + * handled by ruby, either filtering some warnings, and/or outputing + * warnings somewhere other than $stderr. When Warning.warn is + * overridden, super can be called to get the default behavior of + * printing the warning to $stderr. + * + */ + VALUE rb_warning_warn(VALUE mod, VALUE str) { -- cgit v1.2.3