X-Git-Url: https://git.adam-barratt.org.uk/?p=mirror%2Fdsa-puppet.git;a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fvalidate_absolute_path.rb;h=7d794452fc8b29f49229eb4f3308443c2a7e39bd;hp=0db10c3f5dde2ec4b81642e961fc5ebc3b1b40c9;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_absolute_path.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_absolute_path.rb
index 0db10c3f5..7d794452f 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_absolute_path.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_absolute_path.rb
@@ -2,31 +2,36 @@
 # validate_absolute_path.rb
 #
 module Puppet::Parser::Functions
-  newfunction(:validate_absolute_path, :doc => <<-'DOC') do |args|
-    Validate the string represents an absolute path in the filesystem.  This function works
-    for windows and unix style paths.
-
-    The following values will pass:
-
-        $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet'
-        validate_absolute_path($my_path)
-        $my_path2 = '/var/lib/puppet'
-        validate_absolute_path($my_path2)
-        $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet']
-        validate_absolute_path($my_path3)
-        $my_path4 = ['/var/lib/puppet','/usr/share/puppet']
-        validate_absolute_path($my_path4)
-
-    The following values will fail, causing compilation to abort:
-
-        validate_absolute_path(true)
-        validate_absolute_path('../var/lib/puppet')
-        validate_absolute_path('var/lib/puppet')
-        validate_absolute_path([ 'var/lib/puppet', '/var/foo' ])
-        validate_absolute_path([ '/var/lib/puppet', 'var/foo' ])
-        $undefined = undef
-        validate_absolute_path($undefined)
-
+  newfunction(:validate_absolute_path, :doc => <<-DOC) do |args|
+    @summary
+      Validate the string represents an absolute path in the filesystem.  This function works
+      for windows and unix style paths.
+
+    @return
+      passes when the string is an absolute path or raise an error when it is not and fails compilation
+
+    @example **Usage**
+
+      The following values will pass:
+
+          $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet'
+          validate_absolute_path($my_path)
+          $my_path2 = '/var/lib/puppet'
+          validate_absolute_path($my_path2)
+          $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet']
+          validate_absolute_path($my_path3)
+          $my_path4 = ['/var/lib/puppet','/usr/share/puppet']
+          validate_absolute_path($my_path4)
+
+      The following values will fail, causing compilation to abort:
+
+          validate_absolute_path(true)
+          validate_absolute_path('../var/lib/puppet')
+          validate_absolute_path('var/lib/puppet')
+          validate_absolute_path([ 'var/lib/puppet', '/var/foo' ])
+          validate_absolute_path([ '/var/lib/puppet', 'var/foo' ])
+          $undefined = undef
+          validate_absolute_path($undefined)
     DOC
 
     require 'puppet/util'