aboutsummaryrefslogtreecommitdiffstats
path: root/error.c
diff options
context:
space:
mode:
Diffstat (limited to 'error.c')
-rw-r--r--error.c25
1 files changed, 25 insertions, 0 deletions
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)
{