puppet-strings 0.99.0 → 1.0.0

data/lib/puppet-strings/json.rb

@@ -25,23 +25,32 @@ module PuppetStrings::Json
     end
   end
 
+  # Converts a list of tags into an array of hashes.
+  # @param [Array] tags List of tags to be converted into an array of hashes.
+  # @return [Array] Returns an array of tag hashes.
+  def self.tags_to_hashes(tags)
+    # Skip over the API tags that are public
+    tags.select { |t| (t.tag_name != 'api' || t.text != 'public') }.map do |t|
+      next t.to_hash if t.respond_to?(:to_hash)
+
+      tag = { tag_name: t.tag_name }
+      tag[:text] = t.text if t.text
+      tag[:types] = t.types if t.types
+      tag[:name] = t.name if t.name
+      tag
+    end
+  end
+
   # Converts a YARD::Docstring (or String) to a docstring hash for JSON output.
   # @param [YARD::Docstring, String] docstring The docstring to convert to a hash.
+  # @param [Array] select_tags List of tags to select. Other tags will be filtered out.
   # @return [Hash] Returns a hash representation of the given docstring.
-  def self.docstring_to_hash(docstring)
+  def self.docstring_to_hash(docstring, select_tags=nil)
     hash = {}
     hash[:text] = docstring
     if docstring.is_a? YARD::Docstring
-      # Skip over the API tags that are public
-      tags = docstring.tags.select { |t| t.tag_name != 'api' || t.text != 'public' }.map do |t|
-        next t.to_hash if t.respond_to?(:to_hash)
+      tags = tags_to_hashes(docstring.tags.select { |t| select_tags.nil? || select_tags.include?(t.tag_name.to_sym) })
 
-        tag = { tag_name: t.tag_name }
-        tag[:text] = t.text if t.text
-        tag[:types] = t.types if t.types
-        tag[:name] = t.name if t.name
-        tag
-      end
       hash[:tags] = tags unless tags.empty?
     end
     hash

data/lib/puppet-strings/tasks/gh_pages.rb

@@ -2,7 +2,6 @@ require 'puppet-strings/tasks'
 
 namespace :strings do
   namespace :gh_pages do
-    desc 'Checkout the gh-pages branch for doc generation.'
     task :checkout do
       if Dir.exist?('doc')
         fail "The 'doc' directory (#{File.expand_path('doc')}) is not a Git repository! Remove it and run the Rake task again." unless Dir.exist?('doc/.git')
@@ -24,19 +23,31 @@ namespace :strings do
       end
     end
 
-    desc 'Push new docs to GitHub.'
+    task :configure do
+      unless File.exist?(File.join('doc', '_config.yml'))
+        Dir.chdir('doc') do
+          File.open('_config.yml', 'w+') {|f| f.write("include: _index.html") }
+        end
+      end
+    end
+
     task :push do
+      output = `git describe --long 2>/dev/null`
+      # If a project has never been tagged, fall back to latest SHA
+      output.empty? ? git_sha = `git log --pretty=format:'%H' -n 1` : git_sha = output
+
       Dir.chdir('doc') do
         system 'git add .'
-        system "git commit -m '[strings] Generated Documentation Update'"
+        system "git commit -m '[strings] Generated Documentation Update at Revision #{git_sha}'"
         system 'git push origin gh-pages -f'
       end
     end
 
-    desc 'Run checkout, generate, and push tasks.'
+    desc 'Update docs on the gh-pages branch and push to GitHub.'
     task :update => [
       :checkout,
       :'strings:generate',
+      :configure,
       :push,
     ]
   end

data/lib/puppet-strings/yard/code_objects/function.rb

@@ -64,7 +64,7 @@ class PuppetStrings::Yard::CodeObjects::Function < PuppetStrings::Yard::CodeObje
     tags = self.tags(:param)
     args = @parameters.map do |parameter|
       name, default = parameter
-      tag = tags.find { |tag| tag.name == name } if tags
+      tag = tags.find { |t| t.name == name } if tags
       type = tag && tag.types ? "#{tag.type} " : 'Any '
       prefix = "#{name[0]}" if name.start_with?('*', '&')
       name = name[1..-1] if prefix
@@ -78,12 +78,22 @@ class PuppetStrings::Yard::CodeObjects::Function < PuppetStrings::Yard::CodeObje
   # @return [Hash] Returns a hash representation of the code object.
   def to_hash
     hash = {}
+
     hash[:name] = name
     hash[:file] = file
     hash[:line] = line
     hash[:type] = @function_type.to_s
-    signature = self.signature
-    hash[:signature] = signature unless signature.empty?
+    hash[:signatures] = []
+    
+    if self.has_tag? :overload
+      # loop over overloads and append onto the signatures array
+      self.tags(:overload).each do |o|
+        hash[:signatures] << { :signature => o.signature, :docstring => PuppetStrings::Json.docstring_to_hash(o.docstring, [:param, :return]) }
+      end
+    else
+      hash[:signatures] << { :signature => self.signature, :docstring =>  PuppetStrings::Json.docstring_to_hash(docstring, [:param, :return]) }
+    end
+
     hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring)
     defaults = Hash[*parameters.select{ |p| !p[1].nil? }.flatten]
     hash[:defaults] = defaults unless defaults.empty?

data/lib/puppet-strings/yard/code_objects/provider.rb

@@ -56,13 +56,12 @@ class PuppetStrings::Yard::CodeObjects::Provider < PuppetStrings::Yard::CodeObje
   end
 
   # Adds a default to the provider.
-  # @param [String] key The default's key.
-  # @param [String] value The default's value.
+  # @param [Array] constraints List of related key-pair values for the default.
   # @return [void]
-  def add_default(key, value)
-    return unless key && value
-    @defaults ||= {}
-    @defaults[key] = value
+  def add_default(constraints)
+    return unless constraints
+    @defaults ||= []
+    @defaults << constraints
   end
 
   # Adds a command to the provider.

data/lib/puppet-strings/yard/code_objects/type.rb

@@ -1,4 +1,5 @@
 require 'puppet-strings/yard/code_objects/group'
+require 'puppet-strings/yard/util'
 
 # Implements the group for Puppet resource types.
 class PuppetStrings::Yard::CodeObjects::Types < PuppetStrings::Yard::CodeObjects::Group
@@ -78,7 +79,7 @@ class PuppetStrings::Yard::CodeObjects::Type < PuppetStrings::Yard::CodeObjects:
     # @param [String] docstring The docstring of the feature.
     def initialize(name, docstring)
       @name = name
-      @docstring = docstring
+      @docstring = PuppetStrings::Yard::Util.scrub_string(docstring).gsub("\n", ' ')
     end
 
     # Converts the feature to a hash representation.

data/lib/puppet-strings/yard/handlers/puppet/function_handler.rb

@@ -20,7 +20,7 @@ class PuppetStrings::Yard::Handlers::Puppet::FunctionHandler < PuppetStrings::Ya
     set_parameter_types(object)
 
     # Add a return tag
-    add_return_tag(object)
+    add_return_tag(object, statement.type)
 
     # Set the parameters on the object
     object.parameters = statement.parameters.map { |p| [p.name, p.value] }
@@ -30,13 +30,18 @@ class PuppetStrings::Yard::Handlers::Puppet::FunctionHandler < PuppetStrings::Ya
   end
 
   private
-  def add_return_tag(object)
+  def add_return_tag(object, type=nil)
     tag = object.tag(:return)
     if tag
-      tag.types = ['Any'] unless tag.types
+      if (type && tag.types) && (type != tag.types)
+        log.warn "Documented return type does not match return type in function definition near #{statement.file}:#{statement.line}."
+      end
+
+      tag.types = type ? [type] : tag.types || ['Any']
       return
     end
     log.warn "Missing @return tag near #{statement.file}:#{statement.line}."
-    object.add_tag YARD::Tags::Tag.new(:return, '', 'Any')
+    type = type || 'Any'
+    object.add_tag YARD::Tags::Tag.new(:return, '', type)
   end
 end

data/lib/puppet-strings/yard/handlers/ruby/function_handler.rb

@@ -1,6 +1,6 @@
 require 'puppet-strings/yard/handlers/ruby/base'
 require 'puppet-strings/yard/code_objects'
-require 'puppet/util/docs'
+require 'puppet-strings/yard/util'
 
 # Implements the handler for Puppet functions written in Ruby.
 class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard::Handlers::Ruby::Base
@@ -15,6 +15,7 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
     block_param
     required_block_param
     optional_block_param
+    return_type
   ).freeze
 
   namespace_only
@@ -23,12 +24,15 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
 
   process do
     # Only accept calls to Puppet::Functions (4.x) or Puppet::Parser::Functions (3.x)
+    # When `newfunction` is separated from the Puppet::Parser::Functions module name by a
+    # newline, YARD ignores the namespace and uses `newfunction` as the source of the
+    # first statement.
     return unless statement.count > 1
     module_name = statement[0].source
-    return unless module_name == 'Puppet::Functions' || module_name == 'Puppet::Parser::Functions'
+    return unless module_name == 'Puppet::Functions' || module_name == 'Puppet::Parser::Functions' || module_name == 'newfunction'
 
     # Create and register the function object
-    is_3x = module_name == 'Puppet::Parser::Functions'
+    is_3x = module_name == 'Puppet::Parser::Functions' || module_name == 'newfunction'
     object = PuppetStrings::Yard::CodeObjects::Function.new(
       get_name,
       is_3x ? PuppetStrings::Yard::CodeObjects::Function::RUBY_3X : PuppetStrings::Yard::CodeObjects::Function::RUBY_4X
@@ -130,6 +134,11 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
       method_name = child.method_name.source
       next unless DISPATCH_METHOD_NAMES.include?(method_name)
 
+      if method_name == 'return_type'
+        overload_tag.tag(:return).types = [node_as_string(child.parameters[0])]
+        next
+      end
+
       # Check for block
       if method_name.include?('block')
         if block
@@ -335,7 +344,7 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
         docstring = node_as_string(kvp[1])
 
         log.error "Failed to parse docstring for 3.x Puppet function '#{name}' near #{statement.file}:#{statement.line}." and return nil unless docstring
-        return Puppet::Util::Docs.scrub(docstring)
+        return PuppetStrings::Yard::Util.scrub_string(docstring)
       end
     end
 

data/lib/puppet-strings/yard/handlers/ruby/provider_handler.rb

@@ -1,6 +1,6 @@
 require 'puppet-strings/yard/handlers/ruby/base'
 require 'puppet-strings/yard/code_objects'
-require 'puppet/util/docs'
+require 'puppet-strings/yard/util'
 
 # Implements the handler for Puppet providers written in Ruby.
 class PuppetStrings::Yard::Handlers::Ruby::ProviderHandler < PuppetStrings::Yard::Handlers::Ruby::Base
@@ -53,7 +53,7 @@ class PuppetStrings::Yard::Handlers::Ruby::ProviderHandler < PuppetStrings::Yard
         next unless ivar != child && ivar.source == '@doc'
         docstring = node_as_string(child[1])
         log.error "Failed to parse docstring for Puppet provider '#{object.name}' (resource type '#{object.type_name}') near #{child.file}:#{child.line}." and return nil unless docstring
-        register_docstring(object, Puppet::Util::Docs.scrub(docstring), nil)
+        register_docstring(object, PuppetStrings::Yard::Util.scrub_string(docstring), nil)
         return nil
       elsif child.is_a?(YARD::Parser::Ruby::MethodCallNode)
         # Look for a call to a dispatch method with a block
@@ -64,7 +64,7 @@ class PuppetStrings::Yard::Handlers::Ruby::ProviderHandler < PuppetStrings::Yard
 
         docstring = node_as_string(child.parameters[0])
         log.error "Failed to parse docstring for Puppet provider '#{object.name}' (resource type '#{object.type_name}') near #{child.file}:#{child.line}." and return nil unless docstring
-        register_docstring(object, Puppet::Util::Docs.scrub(docstring), nil)
+        register_docstring(object, PuppetStrings::Yard::Util.scrub_string(docstring), nil)
         return nil
       end
     end
@@ -96,9 +96,14 @@ class PuppetStrings::Yard::Handlers::Ruby::ProviderHandler < PuppetStrings::Yard
       elsif method_name == 'defaultfor'
         # Add a default to the object
         next unless parameters.count >= 1
-        parameters[0].each do |kvp|
-          next unless kvp.count == 2
-          object.add_default(node_as_string(kvp[0]) || kvp[0].source, node_as_string(kvp[1]) || kvp[1].source)
+        # Some defaultfor statements contain multiple constraints.
+        parameters.each do |kvps|
+          next unless kvps.count >= 1
+          defaultfor = []
+          kvps.each do |kvp|
+            defaultfor << [node_as_string(kvp[0]) || kvp[0].source, node_as_string(kvp[1]) || kvp[1].source]
+          end
+          object.add_default(defaultfor)
         end
       elsif method_name == 'commands'
         # Add the commands to the object

data/lib/puppet-strings/yard/handlers/ruby/type_handler.rb

@@ -1,6 +1,6 @@
 require 'puppet-strings/yard/handlers/ruby/base'
 require 'puppet-strings/yard/code_objects'
-require 'puppet/util'
+require 'puppet-strings/yard/util'
 
 # Implements the handler for Puppet resource types written in Ruby.
 class PuppetStrings::Yard::Handlers::Ruby::TypeHandler < PuppetStrings::Yard::Handlers::Ruby::Base
@@ -49,7 +49,7 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeHandler < PuppetStrings::Yard::Ha
         next unless ivar != child && ivar.source == '@doc'
         docstring = node_as_string(child[1])
         log.error "Failed to parse docstring for #{kind} near #{child.file}:#{child.line}." and return nil unless docstring
-        return Puppet::Util::Docs.scrub(docstring)
+        return PuppetStrings::Yard::Util.scrub_string(docstring)
       elsif child.is_a?(YARD::Parser::Ruby::MethodCallNode)
         # Look for a call to a dispatch method with a block
         next unless child.method_name &&
@@ -58,7 +58,7 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeHandler < PuppetStrings::Yard::Ha
 
         docstring = node_as_string(child.parameters[0])
         log.error "Failed to parse docstring for #{kind} near #{child.file}:#{child.line}." and return nil unless docstring
-        return Puppet::Util::Docs.scrub(docstring)
+        return PuppetStrings::Yard::Util.scrub_string(docstring)
       end
     end
     log.warn "Missing a description for #{kind} at #{node.file}:#{node.line}."

data/lib/puppet-strings/yard/parsers/puppet/statement.rb

@@ -134,6 +134,7 @@ module PuppetStrings::Yard::Parsers::Puppet
   # Implements the Puppet function statement.
   class FunctionStatement < ParameterizedStatement
     attr_reader :name
+    attr_reader :type
 
     # Initializes the Puppet function statement.
     # @param [Puppet::Pops::Model::FunctionDefinition] object The model object for the function statement.
@@ -141,6 +142,13 @@ module PuppetStrings::Yard::Parsers::Puppet
     def initialize(object, file)
       super(object, file)
       @name = object.name
+      if object.respond_to? :return_type
+        type = object.return_type
+        if type
+          adapter = ::Puppet::Pops::Adapters::SourcePosAdapter.adapt(type)
+          @type = adapter.extract_text.gsub('>> ', '')
+        end
+      end
     end
   end
 end

data/lib/puppet-strings/yard/tags/overload_tag.rb

@@ -21,7 +21,7 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
     tags = self.tags(:param)
     args = @parameters.map do |parameter|
       name, default = parameter
-      tag = tags.find { |tag| tag.name == name } if tags
+      tag = tags.find { |t| t.name == name } if tags
       type = tag && tag.types ? "#{tag.type} " : 'Any '
       prefix = "#{name[0]}" if name.start_with?('*', '&')
       name = name[1..-1] if prefix
@@ -99,7 +99,7 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
     hash[:tag_name] = tag_name
     hash[:text] = text if text
     hash[:signature] = signature
-    hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring) if !docstring.empty?
+    hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring) if !docstring.blank?
     defaults = Hash[*parameters.select{ |p| !p[1].nil? }.flatten]
     hash[:defaults] = defaults unless defaults.empty?
     hash[:types] = types if types

data/lib/puppet-strings/yard/templates/default/fulldoc/html/css/common.css

@@ -0,0 +1,8 @@
+/* Ensure the search bar doesn't overlap with links */
+.fixed_header {
+  padding-bottom: 25px;
+}
+
+#full_list {
+  padding-top: 15px;
+}

data/lib/puppet-strings/yard/templates/default/puppet_provider/html/collection.erb

@@ -2,8 +2,15 @@
 <div class="tags">
   <p class="tag_title"><%= @title %></p>
   <ul>
-  <% @collection.each do |key, value| %>
-    <li><tt><%= key %> &mdash; <%= value %></tt></li>
+
+  <% if @collection.is_a?(Hash) %>
+    <% @collection.each do |key, value| %>
+      <li><tt><%= key %> &mdash; <%= value %></tt></li>
+    <% end %>
+  <% elsif @collection.is_a?(Array) %>
+    <% @collection.each do |kvps| %>
+      <li><tt><%=  kvps.map{|k,v| "#{k} &mdash; #{v}"}.join(', ') %></tt></li>
+    <% end %>
   <% end %>
   </ul>
 </div>

data/lib/puppet-strings/yard/templates/default/tags/html/puppet_overload.erb

@@ -1,5 +1,5 @@
 <% if object.has_tag?(:overload) && object.tags(:overload).any? {|o| !o.docstring.blank? } %>
-  <p class="tag_title">Overloads:</p>
+  <p class="tag_title">Signatures:</p>
   <ul class="overload">
     <% object.tags(:overload).each_with_index do |overload, index| %>
       <% next if overload.docstring.blank? %>

data/lib/puppet-strings/yard/util.rb

@@ -0,0 +1,17 @@
+require 'puppet/util'
+
+# The module for various puppet-strings utility helpers.
+module PuppetStrings::Yard::Util
+  # Trims indentation from trailing whitespace and removes ruby literal quotation
+  # syntax `%Q{}` and `%{q}` from parsed strings.
+  # @param [String] str The string to scrub.
+  # @return [String] A scrubbed string.
+  def self.scrub_string(str)
+    match = str.match(/^%[Qq]{(.*)}$/m)
+    if match
+      return Puppet::Util::Docs.scrub(match[1])
+    end
+
+    Puppet::Util::Docs.scrub(str)
+  end
+end

data/spec/acceptance/emit_json_options.rb

@@ -15,7 +15,21 @@ expected = {
     "file" => "/etc/puppet/modules/test/lib/puppet/parser/functions/function3x.rb",
     "line" => 1,
     "type" => "ruby3x",
-    "signature" => "function3x()",
+    "signatures" => [
+      {
+        "signature" =>"function3x()",
+        "docstring" => {
+          "text" => "This is the function documentation for `function3x`",
+          "tags" => [
+            {
+              "tag_name"=>"return",
+              "text"=>"",
+              "types"=>["Any"]
+            }
+          ]
+        }
+      },
+    ],
     "docstring" => {
       "text" => "This is the function documentation for `function3x`",
       "tags" => ["tag_name" => "return", "text" => "", "types" => ["Any"]]},

data/spec/fixtures/unit/json/output.json

@@ -84,7 +84,7 @@
     {
       "name": "database",
       "file": "(stdin)",
-      "line": 43,
+      "line": 54,
       "docstring": {
         "text": "An example database server resource type."
       },
@@ -154,7 +154,7 @@
       "name": "linux",
       "type_name": "database",
       "file": "(stdin)",
-      "line": 33,
+      "line": 43,
       "docstring": {
         "text": "An example provider on Linux."
       },
@@ -166,9 +166,24 @@
         "implements_some_feature",
         "some_other_feature"
       ],
-      "defaults": {
-        "kernel": "Linux"
-      },
+      "defaults": [
+        [
+          [
+            "kernel",
+            "Linux"
+          ]
+        ],
+        [
+          [
+            "osfamily",
+            "RedHat"
+          ],
+          [
+            "operatingsystemmajrelease",
+            "7"
+          ]
+        ]
+      ],
       "commands": {
         "foo": "/usr/bin/foo"
       }
@@ -180,7 +195,47 @@
       "file": "(stdin)",
       "line": 6,
       "type": "puppet",
-      "signature": "func(Integer $param1, Any $param2, String $param3 = hi)",
+      "signatures": [
+        {
+          "signature": "func(Integer $param1, Any $param2, String $param3 = hi)",
+          "docstring": {
+            "text": "A simple function.",
+            "tags": [
+              {
+                "tag_name": "param",
+                "text": "First param.",
+                "types": [
+                  "Integer"
+                ],
+                "name": "param1"
+              },
+              {
+                "tag_name": "param",
+                "text": "Second param.",
+                "types": [
+                  "Any"
+                ],
+                "name": "param2"
+              },
+              {
+                "tag_name": "param",
+                "text": "Third param.",
+                "types": [
+                  "String"
+                ],
+                "name": "param3"
+              },
+              {
+                "tag_name": "return",
+                "text": "Returns nothing.",
+                "types": [
+                  "Undef"
+                ]
+              }
+            ]
+          }
+        }
+      ],
       "docstring": {
         "text": "A simple function.",
         "tags": [
@@ -227,7 +282,39 @@
       "file": "(stdin)",
       "line": 1,
       "type": "ruby3x",
-      "signature": "func3x(String $first, Any $second)",
+      "signatures": [
+        {
+          "signature": "func3x(String $first, Any $second)",
+          "docstring": {
+            "text": "An example 3.x function.",
+            "tags": [
+              {
+                "tag_name": "param",
+                "text": "The first parameter.",
+                "types": [
+                  "String"
+                ],
+                "name": "first"
+              },
+              {
+                "tag_name": "param",
+                "text": "The second parameter.",
+                "types": [
+                  "Any"
+                ],
+                "name": "second"
+              },
+              {
+                "tag_name": "return",
+                "text": "Returns nothing.",
+                "types": [
+                  "Undef"
+                ]
+              }
+            ]
+          }
+        }
+      ],
       "docstring": {
         "text": "An example 3.x function.",
         "tags": [
@@ -263,6 +350,78 @@
       "file": "(stdin)",
       "line": 11,
       "type": "ruby4x",
+      "signatures": [
+        {
+          "signature": "func4x(Integer $param1, Any $param2, Optional[Array[String]] $param3)",
+          "docstring": {
+            "text": "The first overload.",
+            "tags": [
+              {
+                "tag_name": "param",
+                "text": "The first parameter.",
+                "types": [
+                  "Integer"
+                ],
+                "name": "param1"
+              },
+              {
+                "tag_name": "param",
+                "text": "The second parameter.",
+                "types": [
+                  "Any"
+                ],
+                "name": "param2"
+              },
+              {
+                "tag_name": "param",
+                "text": "The third parameter.",
+                "types": [
+                  "Optional[Array[String]]"
+                ],
+                "name": "param3"
+              },
+              {
+                "tag_name": "return",
+                "text": "Returns nothing.",
+                "types": [
+                  "Undef"
+                ]
+              }
+            ]
+          }
+        },
+        {
+          "signature": "func4x(Boolean $param, Callable &$block)",
+          "docstring": {
+            "text": "",
+            "tags": [
+              {
+                "tag_name": "param",
+                "text": "The first parameter.",
+                "types": [
+                  "Boolean"
+                ],
+                "name": "param"
+              },
+              {
+                "tag_name": "param",
+                "text": "The block parameter.",
+                "types": [
+                  "Callable"
+                ],
+                "name": "&block"
+              },
+              {
+                "tag_name": "return",
+                "text": "Returns a string.",
+                "types": [
+                  "String"
+                ]
+              }
+            ]
+          }
+        }
+      ],
       "docstring": {
         "text": "An example 4.x function.",
         "tags": [
@@ -311,7 +470,7 @@
             "tag_name": "overload",
             "signature": "func4x(Boolean $param, Callable &$block)",
             "docstring": {
-              "text": "The second overload.",
+              "text": "",
               "tags": [
                 {
                   "tag_name": "param",
@@ -342,7 +501,59 @@
           }
         ]
       },
-      "source": "Puppet::Functions.create_function(:func4x) do\n  # The first overload.\n  # @param param1 The first parameter.\n  # @param param2 The second parameter.\n  # @param param3 The third parameter.\n  # @return [Undef] Returns nothing.\n  dispatch :foo do\n    param          'Integer',       :param1\n    param          'Any',           :param2\n    optional_param 'Array[String]', :param3\n  end\n\n  # The second overload.\n  # @param param The first parameter.\n  # @param block The block parameter.\n  # @return [String] Returns a string.\n  dispatch :other do\n    param 'Boolean', :param\n    block_param\n  end\nend"
+      "source": "Puppet::Functions.create_function(:func4x) do\n  # The first overload.\n  # @param param1 The first parameter.\n  # @param param2 The second parameter.\n  # @param param3 The third parameter.\n  # @return Returns nothing.\n  dispatch :foo do\n    param          'Integer',       :param1\n    param          'Any',           :param2\n    optional_param 'Array[String]', :param3\n    return_type 'Undef'\n  end\n\n  # @param param The first parameter.\n  # @param block The block parameter.\n  # @return Returns a string.\n  dispatch :other do\n    param 'Boolean', :param\n    block_param\n    return_type 'String'\n  end\nend"
+    },
+    {
+      "name": "func4x_1",
+      "file": "(stdin)",
+      "line": 35,
+      "type": "ruby4x",
+      "signatures": [
+        {
+          "signature": "func4x_1(Integer $param1)",
+          "docstring": {
+            "text": "An example 4.x function with only one signature.",
+            "tags": [
+              {
+                "tag_name": "param",
+                "text": "The first parameter.",
+                "types": [
+                  "Integer"
+                ],
+                "name": "param1"
+              },
+              {
+                "tag_name": "return",
+                "text": "Returns nothing.",
+                "types": [
+                  "Undef"
+                ]
+              }
+            ]
+          }
+        }
+      ],
+      "docstring": {
+        "text": "An example 4.x function with only one signature.",
+        "tags": [
+          {
+            "tag_name": "param",
+            "text": "The first parameter.",
+            "types": [
+              "Integer"
+            ],
+            "name": "param1"
+          },
+          {
+            "tag_name": "return",
+            "text": "Returns nothing.",
+            "types": [
+              "Undef"
+            ]
+          }
+        ]
+      },
+      "source": "Puppet::Functions.create_function(:func4x_1) do\n  # @param param1 The first parameter.\n  # @return [Undef] Returns nothing.\n  dispatch :foobarbaz do\n    param          'Integer',       :param1\n  end\nend"
     }
   ]
 }