summaryrefslogtreecommitdiff
path: root/error.c
diff options
context:
space:
mode:
authormarcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2010-05-17 21:31:22 +0000
committermarcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2010-05-17 21:31:22 +0000
commitc1ecff1b1e2eb1c4a10e305dd6cc25d7a94436f6 (patch)
treeb89029a472c274adcef054d03a694fd5905780cf /error.c
parentef83d7a928ef9d998dc9cf9cb86649cdd9ffceea (diff)
* hash.c: Documentation: change => in call-seq to ->.
* enum.c: Documentation: whitespace fix for r27865 * error.c: ditto * file.c: ditto * io.c: ditto * load.c: ditto git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@27869 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'error.c')
-rw-r--r--error.c40
1 files changed, 20 insertions, 20 deletions
diff --git a/error.c b/error.c
index 386c9e44f8..05e6b08f8d 100644
--- a/error.c
+++ b/error.c
@@ -194,7 +194,7 @@ rb_warning(const char *fmt, ...)
/*
* call-seq:
- * warn(msg) ->nil
+ * warn(msg) -> nil
*
* Display the given message (followed by a newline) on STDERR unless
* warnings are disabled (for example with the <code>-W0</code> flag).
@@ -429,7 +429,7 @@ rb_exc_new3(VALUE etype, VALUE str)
/*
* call-seq:
- * Exception.new(msg = nil) -> exception
+ * Exception.new(msg = nil) -> exception
*
* Construct a new Exception object, optionally passing in
* a message.
@@ -451,7 +451,7 @@ exc_initialize(int argc, VALUE *argv, VALUE exc)
* Document-method: exception
*
* call-seq:
- * exc.exception(string) -> an_exception or exc
+ * exc.exception(string) -> an_exception or exc
*
* With no argument, or if the argument is the same as the receiver,
* return the receiver. Otherwise, create a new
@@ -475,7 +475,7 @@ exc_exception(int argc, VALUE *argv, VALUE self)
/*
* call-seq:
- * exception.to_s -> string
+ * exception.to_s -> string
*
* Returns exception's message (or the name of the exception if
* no message is set).
@@ -493,7 +493,7 @@ exc_to_s(VALUE exc)
/*
* call-seq:
- * exception.message -> string
+ * exception.message -> string
*
* Returns the result of invoking <code>exception.to_s</code>.
* Normally this returns the exception's message or name. By
@@ -509,7 +509,7 @@ exc_message(VALUE exc)
/*
* call-seq:
- * exception.inspect ->string
+ * exception.inspect -> string
*
* Return this exception's class name an message
*/
@@ -537,7 +537,7 @@ exc_inspect(VALUE exc)
/*
* call-seq:
- * exception.backtrace ->array
+ * exception.backtrace -> array
*
* Returns any backtrace associated with the exception. The backtrace
* is an array of strings, each containing either ``filename:lineNo: in
@@ -597,7 +597,7 @@ rb_check_backtrace(VALUE bt)
/*
* call-seq:
- * exc.set_backtrace(array) -> array
+ * exc.set_backtrace(array) -> array
*
* Sets the backtrace information associated with <i>exc</i>. The
* argument must be an array of <code>String</code> objects in the
@@ -613,7 +613,7 @@ exc_set_backtrace(VALUE exc, VALUE bt)
/*
* call-seq:
- * exc == obj ->true or false
+ * exc == obj -> true or false
*
* Equality---If <i>obj</i> is not an <code>Exception</code>, returns
* <code>false</code>. Otherwise, returns <code>true</code> if <i>exc</i> and
@@ -653,7 +653,7 @@ exc_equal(VALUE exc, VALUE obj)
/*
* call-seq:
- * SystemExit.new(status=0) ->system_exit
+ * SystemExit.new(status=0) -> system_exit
*
* Create a new +SystemExit+ exception with the given status.
*/
@@ -674,7 +674,7 @@ exit_initialize(int argc, VALUE *argv, VALUE exc)
/*
* call-seq:
- * system_exit.status ->fixnum
+ * system_exit.status -> fixnum
*
* Return the status value associated with this system exit.
*/
@@ -688,7 +688,7 @@ exit_status(VALUE exc)
/*
* call-seq:
- * system_exit.success? ->true or false
+ * system_exit.success? -> true or false
*
* Returns +true+ if exiting successful, +false+ if not.
*/
@@ -719,7 +719,7 @@ rb_name_error(ID id, const char *fmt, ...)
/*
* call-seq:
- * NameError.new(msg [, name]) ->name_error
+ * NameError.new(msg [, name]) -> name_error
*
* Construct a new NameError exception. If given the <i>name</i>
* parameter may subsequently be examined using the <code>NameError.name</code>
@@ -739,7 +739,7 @@ name_err_initialize(int argc, VALUE *argv, VALUE self)
/*
* call-seq:
- * name_error.name -> string or nil
+ * name_error.name -> string or nil
*
* Return the name associated with this NameError exception.
*/
@@ -752,7 +752,7 @@ name_err_name(VALUE self)
/*
* call-seq:
- * name_error.to_s ->string
+ * name_error.to_s -> string
*
* Produce a nicely-formatted string representing the +NameError+.
*/
@@ -774,7 +774,7 @@ name_err_to_s(VALUE exc)
/*
* call-seq:
- * NoMethodError.new(msg, name [, args]) ->no_method_error
+ * NoMethodError.new(msg, name [, args]) -> no_method_error
*
* Construct a NoMethodError exception for a method of the given name
* called with the given arguments. The name may be accessed using
@@ -903,7 +903,7 @@ name_err_mesg_load(VALUE klass, VALUE str)
/*
* call-seq:
- * no_method_error.args ->obj
+ * no_method_error.args -> obj
*
* Return the arguments passed in as the third parameter to
* the constructor.
@@ -988,7 +988,7 @@ get_syserr(int n)
/*
* call-seq:
- * SystemCallError.new(msg, errno) ->system_call_error_subclass
+ * SystemCallError.new(msg, errno) -> system_call_error_subclass
*
* If _errno_ corresponds to a known system error code, constructs
* the appropriate <code>Errno</code> class for that error, otherwise
@@ -1043,7 +1043,7 @@ syserr_initialize(int argc, VALUE *argv, VALUE self)
/*
* call-seq:
- * system_call_error.errno ->fixnum
+ * system_call_error.errno -> fixnum
*
* Return this SystemCallError's error number.
*/
@@ -1056,7 +1056,7 @@ syserr_errno(VALUE self)
/*
* call-seq:
- * system_call_error === other ->true or false
+ * system_call_error === other -> true or false
*
* Return +true+ if the receiver is a generic +SystemCallError+, or
* if the error numbers +self+ and _other_ are the same.