From de7690c4e76ddd7c1f01d81fe92c75771da47c51 Mon Sep 17 00:00:00 2001
From: David Schmitt <david@dasz.at>
Date: Tue, 9 Jun 2009 17:51:10 +0200
Subject: RDoc-ify documentation

See http://club.black.co.at/david/puppet/doc/ for a current version of the RDoc
output.
---
 plugins/puppet/parser/functions/basename.rb    | 12 +++++++++---
 plugins/puppet/parser/functions/dirname.rb     | 10 ++++++++--
 plugins/puppet/parser/functions/gsub.rb        | 14 +++++++++-----
 plugins/puppet/parser/functions/prefix_with.rb | 14 ++++++++++++--
 plugins/puppet/parser/functions/re_escape.rb   |  2 +-
 plugins/puppet/parser/functions/split.rb       | 12 +++++++++---
 6 files changed, 48 insertions(+), 16 deletions(-)

(limited to 'plugins/puppet')

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)
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)
diff --git a/plugins/puppet/parser/functions/gsub.rb b/plugins/puppet/parser/functions/gsub.rb
index e2410ff..27e6192 100644
--- a/plugins/puppet/parser/functions/gsub.rb
+++ b/plugins/puppet/parser/functions/gsub.rb
@@ -1,9 +1,13 @@
+#
+# A thin wrapper around the ruby gsub function.
+# 
+#  gsub($string, $pattern, $replacement)
+#
+# will replace all occurrences of $pattern in $string with $replacement.
+# $string can be either a single value or an array. In the latter case, each
+# element of the array will be processed in turn.
+#
 module Puppet::Parser::Functions
-	# thin wrapper around the ruby gsub function
-	# gsub($string, $pattern, $replacement) will replace all occurrences of
-	# $pattern in $string with $replacement. $string can be either a singel
-	# value or an array. In the latter case, each element of the array will
-	# be processed in turn.
 	newfunction(:gsub, :type => :rvalue) do |args|
 		if args[0].is_a?(Array)
 			args[0].collect do |val|
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
diff --git a/plugins/puppet/parser/functions/re_escape.rb b/plugins/puppet/parser/functions/re_escape.rb
index 6e5904b..7bee90a 100644
--- a/plugins/puppet/parser/functions/re_escape.rb
+++ b/plugins/puppet/parser/functions/re_escape.rb
@@ -1,4 +1,4 @@
-# apply regexp escaping to a string
+# apply ruby regexp escaping to a string
 module Puppet::Parser::Functions
 	newfunction(:re_escape, :type => :rvalue) do |args|
 		Regexp.escape(args[0])
diff --git a/plugins/puppet/parser/functions/split.rb b/plugins/puppet/parser/functions/split.rb
index 5237c92..bffecc1 100644
--- a/plugins/puppet/parser/functions/split.rb
+++ b/plugins/puppet/parser/functions/split.rb
@@ -1,9 +1,15 @@
-# split($string, $delimiter) : $string
-# split($string[], $delimiter) : $string[][]
+# This function has two modes of operation: 
 #
-# Split the first argument(s) on every $delimiter. $delimiter is interpreted as
+#  split($string, $delimiter) : $string
+#
+# Split the first argument on every $delimiter. $delimiter is interpreted as
 # Ruby regular expression.
 #
+#  split($string[], $delimiter) : $string[][]
+#
+# Returns an array of split results with the result of applying split to each
+# item from the first argument. 
+#
 # For long-term portability it is recommended to refrain from using Ruby's
 # extended RE features.
 module Puppet::Parser::Functions
-- 
cgit v1.2.3