summaryrefslogtreecommitdiff
path: root/plugins/puppet/parser/functions/dirname.rb
diff options
context:
space:
mode:
authorDavid Schmitt <david@dasz.at>2009-06-09 17:51:10 +0200
committerDavid Schmitt <david@dasz.at>2009-06-09 17:51:10 +0200
commitde7690c4e76ddd7c1f01d81fe92c75771da47c51 (patch)
tree1cba3866aa6db7beb2ba59bddefb508b5d0ddbb7 /plugins/puppet/parser/functions/dirname.rb
parentc65920d6b8d017c951838c72f4bbcb75d5b27234 (diff)
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/dirname.rb')
-rw-r--r--plugins/puppet/parser/functions/dirname.rb10
1 files changed, 8 insertions, 2 deletions
diff --git a/plugins/puppet/parser/functions/dirname.rb b/plugins/puppet/parser/functions/dirname.rb
index 44b4a00..ea0d50b 100644
--- a/plugins/puppet/parser/functions/dirname.rb
+++ b/plugins/puppet/parser/functions/dirname.rb
@@ -1,9 +1,15 @@
-# dirname(string) : string
-# dirname(string[]) : string[]
+# This function has two modes of operation:
+#
+# dirname(string) : string
#
# Returns all components of the filename given as argument except the last
# one. The filename must be formed using forward slashes (``/..) regardless of
# the separator used on the local file system.
+#
+# dirname(string[]) : string[]
+#
+# Returns an array of strings with the basename of each item from the argument.
+#
module Puppet::Parser::Functions
newfunction(:dirname, :type => :rvalue) do |args|
if args[0].is_a?(Array)