markdown_spec.rb in puppet-strings-2.4.0

- old
+ new

@@ -27,15 +27,19 @@
 # @param param1 First param.
 # @param param2 Second param.
 # @option param2 [String] :opt1 something about opt1
 # @option param2 [Hash] :opt2 a hash of stuff
 # @param param3 Third param.
+# @param param4 Fourth param.
+# @enum param4 :one One option
+# @enum param4 :two Second option
 #
 class klass (
   Integer $param1 = 1,
   $param2 = undef,
-  String $param3 = 'hi'
+  String $param3 = 'hi',
+  Enum['one', 'two'] $param4 = 'two',
 ) inherits foo::bar {
 }
 
 # Overview for class noparams
 # @api private
@@ -56,15 +60,19 @@
 # @param param2 Second param.
 # @option param2 [String] :opt1 something about opt1
 # @option param2 [Hash] :opt2 a hash of stuff
 # @param param3 Third param.
 # @param param4 Fourth param.
+# @param param5 Fifth param.
+# @enum param5 :a Option A
+# @enum param5 :b Option B
 define klass::dt (
   Integer $param1 = 44,
   $param2,
   String $param3 = 'hi',
-  Boolean $param4 = true
+  Boolean $param4 = true,
+  Enum['a', 'b'] $param5 = 'a'
 ) {
 }
     SOURCE
 
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :json)
@@ -96,15 +104,18 @@
 # A simple Puppet function.
 # @param param1 First param.
 # @param param2 Second param.
 # @param param3 Third param.
 # @option param3 [Array] :param3opt Something about this option
+# @param param4 Fourth param.
+# @enum param4 :yes Yes option.
+# @enum param4 :no No option.
 # @raise SomeError this is some error
 # @return [Undef] Returns nothing.
 # @example Test
 #   $result = func(1, 2)
-function func(Integer $param1, $param2, String $param3 = hi) {
+function func(Integer $param1, $param2, String $param3 = hi, Enum['yes', 'no'] $param4 = 'yes') {
 }
     SOURCE
 
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
 # An example 4.x function.
@@ -120,18 +131,22 @@
   # @param param1 The first parameter.
   # @param param2 The second parameter.
   # @option param2 [String] :option an option
   # @option param2 [String] :option2 another option
   # @param param3 The third parameter.
+  # @param param4 The fourth parameter.
+  # @enum param4 :one Option one.
+  # @enum param4 :two Option two.
   # @return Returns nothing.
   # @example Calling the function foo
   #   $result = func4x(1, 'foooo')
   #
   dispatch :foo do
     param          'Integer',       :param1
     param          'Any',           :param2
     optional_param 'Array[String]', :param3
+    optional_param 'Enum[one, two]', :param4
     return_type 'Undef'
   end
 
   # An overview for the second overload.
   # @param param The first parameter.
@@ -181,9 +196,11 @@
 
 Puppet::Type.newtype(:database) do
   desc <<-DESC
 An example database server type.
 @option opts :foo bar
+@enum ensure :up Upstate
+@enum ensure :down Downstate
 @raise SomeError
 @example here's an example
  database { 'foo':
    address => 'qux.baz.bar',
  }