add rdoc.

git-svn-id: http://svn.ruby-lang.org/repos/ruby/trunk@14482 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 22 insertions, 2 deletions

diff --git a/string.c b/string.c
index 03a45a58d..bd71bc282 100644
--- a/string.c
+++ b/string.c
@@ -501,8 +501,7 @@ rb_str_length(VALUE str)
  */
 
 static VALUE
-rb_str_bytesize(str)
-    VALUE str;
+rb_str_bytesize(VALUE str)
 {
     return INT2NUM(RSTRING_LEN(str));
 }
@@ -5341,6 +5340,17 @@ rb_str_force_encoding(VALUE str, VALUE enc)
     return str;
 }
 
+/*
+ *  call-seq:
+ *     str.valid_encoding?  => true or false
+ *  
+ *  Returns true for a string which encoded correctly.
+ *
+ *    "\xc2\xa1".force_encoding("UTF-8").valid_encoding? => true
+ *    "\xc2".force_encoding("UTF-8").valid_encoding? => false
+ *    "\x80".force_encoding("UTF-8").valid_encoding? => false
+ */
+
 static VALUE
 rb_str_valid_encoding_p(VALUE str)
 {
@@ -5349,6 +5359,16 @@ rb_str_valid_encoding_p(VALUE str)
     return cr == ENC_CODERANGE_BROKEN ? Qfalse : Qtrue;
 }
 
+/*
+ *  call-seq:
+ *     str.ascii_only?  => true or false
+ *  
+ *  Returns true for a string which has only ASCII characters.
+ *
+ *    "abc".force_encoding("UTF-8").ascii_only? => true
+ *    "abc\u{6666}".force_encoding("UTF-8").ascii_only? => false
+ */
+
 static VALUE
 rb_str_is_ascii_only_p(VALUE str)
 {