diff options
| -rw-r--r-- | ChangeLog | 4 | ||||
| -rw-r--r-- | lib/shellwords.rb | 23 |
2 files changed, 10 insertions, 17 deletions
@@ -1,3 +1,7 @@ +Fri Jan 13 03:46:53 2012 Akinori MUSHA <knu@iDaemons.org> + + * lib/shellwords.rb: Fix rdoc markups. + Fri Jan 13 03:38:36 2012 Akinori MUSHA <knu@iDaemons.org> * lib/shellwords.rb (Shellwords#shellsplit): Fix a bug where diff --git a/lib/shellwords.rb b/lib/shellwords.rb index 20ddfe2646..550c2693de 100644 --- a/lib/shellwords.rb +++ b/lib/shellwords.rb @@ -23,18 +23,16 @@ # * Akinori MUSHA <knu@iDaemons.org> (current maintainer) module Shellwords - # # Splits a string into an array of tokens in the same way the UNIX # Bourne shell does. # # argv = Shellwords.split('here are "two words"') # argv #=> ["here", "are", "two words"] # - # +String#shellsplit+ is a shorthand for this function. + # String#shellsplit is a shorthand for this function. # # argv = 'here are "two words"'.shellsplit # argv #=> ["here", "are", "two words"] - # def shellsplit(line) words = [] field = '' @@ -58,7 +56,6 @@ module Shellwords alias split shellsplit end - # # Escapes a string so that it can be safely used in a Bourne shell # command line. # @@ -69,7 +66,7 @@ module Shellwords # # ... # } # - # +String#shellescape+ is a shorthand for this function. + # String#shellescape is a shorthand for this function. # # open("| grep #{pattern.shellescape} file") { |pipe| # # ... @@ -79,7 +76,6 @@ module Shellwords # encoding for the shell environment where this string is used. # Multibyte characters are treated as multibyte characters, not # bytes. - # def shellescape(str) # An empty argument will be skipped, so return empty quotes. return "''" if str.empty? @@ -104,7 +100,6 @@ module Shellwords alias escape shellescape end - # # Builds a command line string from an argument list +array+ joining # all elements escaped for Bourne shell and separated by a space. # @@ -112,7 +107,7 @@ module Shellwords # # ... # } # - # +Array#shelljoin+ is a shorthand for this function. + # Array#shelljoin is a shorthand for this function. # # open('|' + ['grep', pattern, *files].shelljoin) { |pipe| # # ... @@ -130,38 +125,32 @@ module Shellwords end class String - # # call-seq: # str.shellsplit => array # # Splits +str+ into an array of tokens in the same way the UNIX - # Bourne shell does. See +Shellwords::shellsplit+ for details. - # + # Bourne shell does. See Shellwords::shellsplit for details. def shellsplit Shellwords.split(self) end - # # call-seq: # str.shellescape => string # # Escapes +str+ so that it can be safely used in a Bourne shell - # command line. See +Shellwords::shellescape+ for details. - # + # command line. See Shellwords::shellescape for details. def shellescape Shellwords.escape(self) end end class Array - # # call-seq: # array.shelljoin => string # # Builds a command line string from an argument list +array+ joining # all elements escaped for Bourne shell and separated by a space. - # See +Shellwords::shelljoin+ for details. - # + # See Shellwords::shelljoin for details. def shelljoin Shellwords.join(self) end |