diff options
author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-01-26 03:58:33 +0000 |
---|---|---|
committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-01-26 03:58:33 +0000 |
commit | 0051369ba3eff58cb734795543d7ca894b621d05 (patch) | |
tree | 0c271bf123ac3ae817668d14acc271eec6dfa163 | |
parent | 6048f9a6cf5bc650da33124a5889a3160422f58d (diff) |
* hash.c (rb_env_size): Restored documentation for ENV.size
* lib/drb/drb.rb: Documented DRb::DRb#run.
* lib/erb.rb (class ERB): Improved documentation of ERb.
* transcode.c: Documented Encoding::Converter constants.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38948 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r-- | ChangeLog | 10 | ||||
-rw-r--r-- | hash.c | 18 | ||||
-rw-r--r-- | lib/drb/drb.rb | 4 | ||||
-rw-r--r-- | lib/erb.rb | 10 | ||||
-rw-r--r-- | transcode.c | 69 |
5 files changed, 100 insertions, 11 deletions
@@ -1,3 +1,13 @@ +Sat Jan 26 12:54:40 2013 Eric Hodel <drbrain@segment7.net> + + * hash.c (rb_env_size): Restored documentation for ENV.size + + * lib/drb/drb.rb: Documented DRb::DRb#run. + + * lib/erb.rb (class ERB): Improved documentation of ERb. + + * transcode.c: Documented Encoding::Converter constants. + Sat Jan 26 10:09:57 2013 Eric Hodel <drbrain@segment7.net> * lib/webrick/accesslog.rb: Improved WEBrick documentation. @@ -2566,15 +2566,6 @@ env_keys(void) return ary; } -/* - * call-seq: - * ENV.each_key { |name| } -> Hash - * ENV.each_key -> Enumerator - * - * Yields each environment variable name. - * - * An Enumerator is returned if no block is given. - */ static VALUE rb_env_size(VALUE ehash) { @@ -2593,6 +2584,15 @@ rb_env_size(VALUE ehash) return LONG2FIX(cnt); } +/* + * call-seq: + * ENV.each_key { |name| } -> Hash + * ENV.each_key -> Enumerator + * + * Yields each environment variable name. + * + * An Enumerator is returned if no block is given. + */ static VALUE env_each_key(VALUE ehash) { diff --git a/lib/drb/drb.rb b/lib/drb/drb.rb index 1d3c413e0c..8e03cdcde1 100644 --- a/lib/drb/drb.rb +++ b/lib/drb/drb.rb @@ -1453,6 +1453,10 @@ module DRb end private + + ## + # Starts the DRb main loop in a new thread. + def run Thread.start do begin diff --git a/lib/erb.rb b/lib/erb.rb index b1c200af13..51b128e3c5 100644 --- a/lib/erb.rb +++ b/lib/erb.rb @@ -257,7 +257,7 @@ require "cgi/util" # Rails, the web application framework, uses ERB to create views. # class ERB - Revision = '$Date:: $' #' + Revision = '$Date:: $' # :nodoc: #' # Returns revision information for the erb.rb module. def self.version @@ -800,6 +800,9 @@ class ERB @filename = nil end + ## + # Creates a new compiler for ERB. See ERB::Compiler.new for details + def make_compiler(trim_mode) ERB::Compiler.new(trim_mode) end @@ -847,8 +850,11 @@ class ERB end end + ## + # Returns a new binding each time *near* TOPLEVEL_BINDING for runs that do + # not specify a binding. + def new_toplevel - # New binding each time *near* toplevel for unspecified runs TOPLEVEL_BINDING.dup end private :new_toplevel diff --git a/transcode.c b/transcode.c index 44f5d19a3f..de9edf866a 100644 --- a/transcode.c +++ b/transcode.c @@ -4430,18 +4430,87 @@ Init_transcode(void) rb_define_method(rb_cEncodingConverter, "replacement=", econv_set_replacement, 1); rb_define_method(rb_cEncodingConverter, "==", econv_equal, 1); + /* Document-const: INVALID_MASK + * + * Mask for invalid byte sequences + */ rb_define_const(rb_cEncodingConverter, "INVALID_MASK", INT2FIX(ECONV_INVALID_MASK)); + + /* Document-const: INVALID_REPLACE + * + * Replace invalid byte sequences + */ rb_define_const(rb_cEncodingConverter, "INVALID_REPLACE", INT2FIX(ECONV_INVALID_REPLACE)); + + /* Document-const: UNDEF_MASK + * + * Mask for a valid character in the source encoding but no related + * character(s) in destination encoding. + */ rb_define_const(rb_cEncodingConverter, "UNDEF_MASK", INT2FIX(ECONV_UNDEF_MASK)); + + /* Document-const: UNDEF_REPLACE + * + * Replace byte sequences that are undefined in the destination encoding. + */ rb_define_const(rb_cEncodingConverter, "UNDEF_REPLACE", INT2FIX(ECONV_UNDEF_REPLACE)); + + /* Document-const: UNDEF_HEX_CHARREF + * + * Replace byte sequences that are undefined in the destination encoding + * with an XML hexadecimal character reference. This is valid for XML + * conversion. + */ rb_define_const(rb_cEncodingConverter, "UNDEF_HEX_CHARREF", INT2FIX(ECONV_UNDEF_HEX_CHARREF)); + + /* Document-const: PARTIAL_INPUT + * + * Indicates the source may be part of a larger string. See + * primitive_convert for an example. + */ rb_define_const(rb_cEncodingConverter, "PARTIAL_INPUT", INT2FIX(ECONV_PARTIAL_INPUT)); + + /* Document-const: AFTER_OUTPUT + * + * Stop converting after some output is complete but before all of the + * input was consumed. See primitive_convert for an example. + */ rb_define_const(rb_cEncodingConverter, "AFTER_OUTPUT", INT2FIX(ECONV_AFTER_OUTPUT)); + + /* Document-const: UNIVERSAL_NEWLINE_DECORATOR + * + * Decorator for converting CRLF and CR to LF + */ rb_define_const(rb_cEncodingConverter, "UNIVERSAL_NEWLINE_DECORATOR", INT2FIX(ECONV_UNIVERSAL_NEWLINE_DECORATOR)); + + /* Document-const: CRLF_NEWLINE_DECORATOR + * + * Decorator for converting LF to CRLF + */ rb_define_const(rb_cEncodingConverter, "CRLF_NEWLINE_DECORATOR", INT2FIX(ECONV_CRLF_NEWLINE_DECORATOR)); + + /* Document-const: CR_NEWLINE_DECORATOR + * + * Decorator for converting LF to CR + */ rb_define_const(rb_cEncodingConverter, "CR_NEWLINE_DECORATOR", INT2FIX(ECONV_CR_NEWLINE_DECORATOR)); + + /* Document-const: XML_TEXT_DECORATOR + * + * Escape as XML CharData + */ rb_define_const(rb_cEncodingConverter, "XML_TEXT_DECORATOR", INT2FIX(ECONV_XML_TEXT_DECORATOR)); + + /* Document-const: XML_ATTR_CONTENT_DECORATOR + * + * Escape as XML AttValue + */ rb_define_const(rb_cEncodingConverter, "XML_ATTR_CONTENT_DECORATOR", INT2FIX(ECONV_XML_ATTR_CONTENT_DECORATOR)); + + /* Document-const: XML_ATTR_QUOTE_DECORATOR + * + * Escape as XML AttValue + */ rb_define_const(rb_cEncodingConverter, "XML_ATTR_QUOTE_DECORATOR", INT2FIX(ECONV_XML_ATTR_QUOTE_DECORATOR)); rb_define_method(rb_eUndefinedConversionError, "source_encoding_name", ecerr_source_encoding_name, 0); |