diff options
| author | David Schmitt <david@dasz.at> | 2009-06-09 17:51:10 +0200 |
|---|---|---|
| committer | David Schmitt <david@dasz.at> | 2009-06-09 17:51:10 +0200 |
| commit | de7690c4e76ddd7c1f01d81fe92c75771da47c51 (patch) | |
| tree | 1cba3866aa6db7beb2ba59bddefb508b5d0ddbb7 /plugins/puppet/parser/functions/basename.rb | |
| parent | c65920d6b8d017c951838c72f4bbcb75d5b27234 (diff) | |
| download | puppet-common-de7690c4e76ddd7c1f01d81fe92c75771da47c51.tar.gz puppet-common-de7690c4e76ddd7c1f01d81fe92c75771da47c51.tar.bz2 | |
RDoc-ify documentation
See http://club.black.co.at/david/puppet/doc/ for a current version of the RDoc
output.
Diffstat (limited to 'plugins/puppet/parser/functions/basename.rb')
| -rw-r--r-- | plugins/puppet/parser/functions/basename.rb | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/plugins/puppet/parser/functions/basename.rb b/plugins/puppet/parser/functions/basename.rb index 226d6e5..dc72537 100644 --- a/plugins/puppet/parser/functions/basename.rb +++ b/plugins/puppet/parser/functions/basename.rb @@ -1,9 +1,15 @@ -# basename(string) : string -# basename(string[]) : string[] +# This function has two modes of operation: +# +# basename(string) : string # # Returns the last component of the filename given as argument, which must be -# formed using forward slashes (``/..) regardless of the separator used on the +# formed using forward slashes ("/") regardless of the separator used on the # local file system. +# +# basename(string[]) : string[] +# +# Returns an array of strings with the basename of each item from the argument. +# module Puppet::Parser::Functions newfunction(:basename, :type => :rvalue) do |args| if args[0].is_a?(Array) |