diff options
author | akr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2008-09-25 11:42:49 +0000 |
---|---|---|
committer | akr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2008-09-25 11:42:49 +0000 |
commit | fee3bb664aea493ceb3186d37cc0890484bc8cd1 (patch) | |
tree | 159c5df10751266e058d3cd9351a090c9d031fa4 /transcode.c | |
parent | 7a86a81dccd6aa6c5268196727c86944443cb9de (diff) | |
download | ruby-fee3bb664aea493ceb3186d37cc0890484bc8cd1.tar.gz |
update rdoc.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@19551 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'transcode.c')
-rw-r--r-- | transcode.c | 64 |
1 files changed, 54 insertions, 10 deletions
diff --git a/transcode.c b/transcode.c index 39e3d6cbef..3ced1e8e17 100644 --- a/transcode.c +++ b/transcode.c @@ -2935,17 +2935,20 @@ rb_econv_init_by_convpath(VALUE self, VALUE convpath, * * possible options elements: * hash form: - * :invalid => nil # error on invalid byte sequence (default) - * :invalid => :replace # replace invalid byte sequence - * :undef => nil # error on undefined conversion (default) - * :undef => :replace # replace undefined conversion - * :replace => string # replacement string ("?" or "\uFFFD" if not specified) - * :universal_newline => true # decorator for converting CRLF and CR to LF - * :crlf_newline => true # decorator for converting LF to CRLF - * :cr_newline => true # decorator for converting LF to CR - * :xml => :text # escape as XML CharData (AMPERSAND, LESS-THAN SIGN and GREATER-THAN SIGN are escaped as &, < and >, respectively) - * :xml => :attr # escape as XML AttValue (AMPERSAND, LESS-THAN SIGN, GREATER-THAN SIGN and QUOTATION MARK are escaped as &, <, > and "e;. quoted by QUOTATION MARK.) + * :invalid => nil # raise error on invalid byte sequence (default) + * :invalid => :replace # replace invalid byte sequence + * :undef => nil # raise error on undefined conversion (default) + * :undef => :replace # replace undefined conversion + * :replace => string # replacement string ("?" or "\uFFFD" if not specified) + * :universal_newline => true # decorator for converting CRLF and CR to LF + * :crlf_newline => true # decorator for converting LF to CRLF + * :cr_newline => true # decorator for converting LF to CR + * :xml => :text # escape as XML CharData. + * :xml => :attr # escape as XML AttValue * integer form: + * Encoding::Converter::INVALID_REPLACE + * Encoding::Converter::UNDEF_REPLACE + * Encoding::Converter::UNDEF_HEX_CHARREF * Encoding::Converter::UNIVERSAL_NEWLINE_DECORATOR * Encoding::Converter::CRLF_NEWLINE_DECORATOR * Encoding::Converter::CR_NEWLINE_DECORATOR @@ -2965,6 +2968,47 @@ rb_econv_init_by_convpath(VALUE self, VALUE convpath, * - two-element array which contains encoding or encoding name, or * - a string of decorator name. * + * Encoding::Converter.new optionally takes an option. + * The option should be a hash or an integer. + * The option hash can contain :invalid => nil, etc. + * The option integer should be logical-or of constants such as + * Encoding::Converter::INVALID_REPLACE, etc. + * + * :invalid => nil :: + * raise error on invalid byte sequence. This is a default behavior. + * :invalid => :replace :: + * replace invalid byte sequence as a replacement string. + * :undef => nil :: + * raise error on conversion failure due to an character in source_encoding is not defined in destination_encoding. + * This is a default behavior. + * :undef => :replace :: + * replace undefined character in destination_encoding as a replacement string. + * :replace => string :: + * specify the replacement string. + * If not specified, "\uFFFD" is used for Unicode encodings and "?" for others. + * :universal_newline => true :: + * convert CRLF and CR to LF. + * :crlf_newline => true :: + * convert LF to CRLF. + * :cr_newline => true :: + * convert LF to CR. + * :xml => :text :: + * escape as XML CharData. + * - '&' -> '&' + * - '<' -> '<' + * - '>' -> '>' + * - undefined characters in destination_encoding -> hexadecimal CharRef such as &#xHH; + * This form can be used as a HTML 4.0 #PCDATA. + * :xml => :attr :: + * escape as XML AttValue. + * The converted result is quoted as "...". + * - '&' -> '&' + * - '<' -> '<' + * - '>' -> '>' + * - '"' -> '"' + * - undefined characters in destination_encoding -> hexadecimal CharRef such as &#xHH; + * This form can be used as a HTML 4.0 attribute value. + * * example: * # UTF-16BE to UTF-8 * ec = Encoding::Converter.new("UTF-16BE", "UTF-8") |