summaryrefslogtreecommitdiff
path: root/transcode.c
diff options
context:
space:
mode:
authorakr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-09-25 17:42:52 +0000
committerakr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-09-25 17:42:52 +0000
commit2a608fed889adff42881f5b0e9ca141a42671b01 (patch)
tree40541d2dee23d537198074cb0a541843891f2c8b /transcode.c
parentec0c394b9eb142c8e72e59bfa9061675b1167ed5 (diff)
update rdoc.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@19558 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'transcode.c')
-rw-r--r--transcode.c24
1 files changed, 12 insertions, 12 deletions
diff --git a/transcode.c b/transcode.c
index eebb57044b..26c57d039d 100644
--- a/transcode.c
+++ b/transcode.c
@@ -2974,40 +2974,40 @@ rb_econv_init_by_convpath(VALUE self, VALUE convpath,
* The option integer should be logical-or of constants such as
* Encoding::Converter::INVALID_REPLACE, etc.
*
- * :invalid => nil ::
+ * [:invalid => nil]
* raise error on invalid byte sequence. This is a default behavior.
- * :invalid => :replace ::
+ * [:invalid => :replace]
* replace invalid byte sequence as a replacement string.
- * :undef => nil ::
+ * [: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 ::
+ * [:undef => :replace]
* replace undefined character in destination_encoding as a replacement string.
- * :replace => string ::
+ * [:replace => string]
* specify the replacement string.
* If not specified, "\uFFFD" is used for Unicode encodings and "?" for others.
- * :universal_newline => true ::
+ * [:universal_newline => true]
* convert CRLF and CR to LF.
- * :crlf_newline => true ::
+ * [:crlf_newline => true]
* convert LF to CRLF.
- * :cr_newline => true ::
+ * [:cr_newline => true]
* convert LF to CR.
- * :xml => :text ::
+ * [:xml => :text]
* escape as XML CharData.
+ * This form can be used as a HTML 4.0 #PCDATA.
* - '&' -> '&amp;'
* - '<' -> '&lt;'
* - '>' -> '&gt;'
* - undefined characters in destination_encoding -> hexadecimal CharRef such as &#xHH;
- * This form can be used as a HTML 4.0 #PCDATA.
- * :xml => :attr ::
+ * [:xml => :attr]
* escape as XML AttValue.
* The converted result is quoted as "...".
+ * This form can be used as a HTML 4.0 attribute value.
* - '&' -> '&amp;'
* - '<' -> '&lt;'
* - '>' -> '&gt;'
* - '"' -> '&quot;'
* - 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