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_cmd.rb;h=592d0ee327349aea320fb285e81769bcac8a929f;hp=dbea604df008a448ba8851ed5135804831236778;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_cmd.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_cmd.rb
index dbea604df..592d0ee32 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_cmd.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_cmd.rb
@@ -5,28 +5,33 @@ require 'tempfile'
 # validate_cmd.rb
 #
 module Puppet::Parser::Functions
-  newfunction(:validate_cmd, :doc => <<-'DOC') do |args|
-    Perform validation of a string with an external command.
+  newfunction(:validate_cmd, :doc => <<-DOC
+    @summary
+      Perform validation of a string with an external command.
+
     The first argument of this function should be a string to
     test, and the second argument should be a path to a test command
     taking a % as a placeholder for the file path (will default to the end).
     If the command, launched against a tempfile containing the passed string,
     returns a non-null value, compilation will abort with a parse error.
-
     If a third argument is specified, this will be the error message raised and
     seen by the user.
 
+    @return
+      validate of a string with an external command
+
     A helpful error message can be returned like this:
 
-    Example:
+    @example **Usage**
 
-        # Defaults to end of path
+      Defaults to end of path
         validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content')
 
-        # % as file location
+      % as file location
         validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content')
 
     DOC
+             ) do |args|
     if (args.length < 2) || (args.length > 3)
       raise Puppet::ParseError, "validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)"
     end