diff options
author | gsinclair <gsinclair@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-02-22 00:55:23 +0000 |
---|---|---|
committer | gsinclair <gsinclair@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-02-22 00:55:23 +0000 |
commit | 899fc97c33e3115cba91f691d948e2efce13c4a5 (patch) | |
tree | 2c43a997c8beeafed7237ab225226f4bdb707fc0 /re.c | |
parent | 15c47977f18b0bfe0b662e4eb430a7fb05e6e358 (diff) |
* re.c: corrected documentation format (again)
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@5802 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 're.c')
-rw-r--r-- | re.c | 32 |
1 files changed, 17 insertions, 15 deletions
@@ -1612,25 +1612,27 @@ rb_reg_match_m(re, str) /* * Document-method: compile * - * call-seq: + * Synonym for <code>Regexp.new</code> + */ + +/* + * call-seq: * Regexp.new(string [, options [, lang]]) => regexp * Regexp.new(regexp) => regexp - * Regexp.compile(string [, options [, lang]]) => regexp + * Regexp.compile(string [, options [, lang]]) => regexp * Regexp.compile(regexp) => regexp - * - * Synonym for <code>Regexp.new</code> * - * Constructs a new regular expression from <i>pattern</i>, which can be either - * a <code>String</code> or a <code>Regexp</code> (in which case that regexp's - * options are propagated, and new options may not be specified (a change as of - * Ruby 1.8). If <i>options</i> is a <code>Fixnum</code>, it should be one or - * more of the constants <code>Regexp::EXTENDED</code>, - * <code>Regexp::IGNORECASE</code>, and <code>Regexp::POSIXLINE</code>, - * <em>or</em>-ed together. Otherwise, if <i>options</i> is not - * <code>nil</code>, the regexp will be case insensitive. The <i>lang</i> - * parameter enables multibyte support for the regexp: `n', `N' = none, `e', - * `E' = EUC, `s', `S' = SJIS, `u', `U' = UTF-8. - * + * Constructs a new regular expression from <i>pattern</i>, which can be either + * a <code>String</code> or a <code>Regexp</code> (in which case that regexp's + * options are propagated, and new options may not be specified (a change as of + * Ruby 1.8). If <i>options</i> is a <code>Fixnum</code>, it should be one or + * more of the constants <code>Regexp::EXTENDED</code>, + * <code>Regexp::IGNORECASE</code>, and <code>Regexp::POSIXLINE</code>, + * <em>or</em>-ed together. Otherwise, if <i>options</i> is not + * <code>nil</code>, the regexp will be case insensitive. The <i>lang</i> + * parameter enables multibyte support for the regexp: `n', `N' = none, `e', + * `E' = EUC, `s', `S' = SJIS, `u', `U' = UTF-8. + * * r1 = Regexp.new('^a-z+:\\s+\w+') #=> /^a-z+:\s+\w+/ * r2 = Regexp.new('cat', true) #=> /cat/i * r3 = Regexp.new('dog', Regexp::EXTENDED) #=> /dog/x |