#
module Puppet::Parser::Functions
newfunction(:is_integer, :type => :rvalue, :doc => <<-DOC
- Returns true if the variable passed to this function is an Integer or
- a decimal (base 10) integer in String form. The string may
- start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not
- be followed by other digits as this indicates that the value is octal (base 8).
+ @summary
+ **Deprecated:** Returns true if the variable passed to this function is an Integer or
+ a decimal (base 10) integer in String form.
+
+ The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0'
+ digit may not be followed by other digits as this indicates that the value is octal (base 8).
If given any other argument `false` is returned.
+
+ @return [Boolean]
+ Returns `true` or `false`
+
+ > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
+ [`validate_legacy`](#validate_legacy).
DOC
) do |arguments|