aboutsummaryrefslogtreecommitdiff
path: root/plugins/puppet/parser/functions/prefix_with.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/prefix_with.rb
parentc65920d6b8d017c951838c72f4bbcb75d5b27234 (diff)
downloadpuppet-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/prefix_with.rb')
-rw-r--r--plugins/puppet/parser/functions/prefix_with.rb14
1 files changed, 12 insertions, 2 deletions
diff --git a/plugins/puppet/parser/functions/prefix_with.rb b/plugins/puppet/parser/functions/prefix_with.rb
index 6e64a4a..5a12986 100644
--- a/plugins/puppet/parser/functions/prefix_with.rb
+++ b/plugins/puppet/parser/functions/prefix_with.rb
@@ -1,5 +1,15 @@
-# prefix arguments 2..n with first argument
-
+# Prefixes arguments 2..n with first argument.
+#
+# prefix_with(string prefix, string[] arguments) : string[]
+#
+# Example:
+#
+# prefix_with("php-", [ "blah", "foo" ])
+#
+# will result in this array:
+#
+# [ "php-blah", "php-foo" ]
+#
module Puppet::Parser::Functions
newfunction(:prefix_with, :type => :rvalue) do |args|
prefix = args.shift