Merge pull request #36 from puppetlabs/actually/PDOC-19

Actually/pdoc 19

lib/puppet_x/puppetlabs/strings/yard/handlers/host_class_handler.rb

@@ -18,7 +18,7 @@ class PuppetX::PuppetLabs::Strings::YARD::Handlers::HostClassHandler < PuppetX::
         begin
           param_type_info[pop_param.name] =  tp.interpret_any(pop_param.type_expr)
         rescue Puppet::ParseError
-          # If the type could not be interpreted, default to type Any
+          # If the type could not be interpreted insert a prominent warning
           param_type_info[pop_param.name] = "TypeError - " +
             "#{pop_param.type_expr} isn't a valid type."
         end

lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/parameter_details.erb

@@ -1,6 +1,6 @@
 <h2>Parameter Summary</h2>
 <div class="tags">
   <ul class="param">
-    <%= @html_helper.generate_parameters(@param_details) %>
+    <%= @html_helper.generate_parameters(@param_details, object) %>
   </ul>
 </div>

lib/puppet_x/puppetlabs/strings/yard/templates/default/html_helper.rb

@@ -16,7 +16,7 @@ class HTMLHelper
   end
 
   # Generates the HTML to format the relevant data about parameters
-  def generate_parameters(params)
+  def generate_parameters(params, object)
     result = []
 
     params.each do |param|
@@ -33,13 +33,34 @@ class HTMLHelper
       result << "<span class=\"name\">#{param[:name]} </span>"
       result << "<span class=\"type\">"
 
+      # If the docstring specifies types, use those
       if param[:types]
         result << "(" << "<tt>" << param[:types].join(", ") << "</tt>" << ")"
-      # Don't bother with TBD since 3x functions will never have type info per parameter.
-      # However if the user does want to list a type for some reason that is still supported,
-      # we just don't want to suggest that they need to
+      # Otherwise, if typing information could be extracted from the object
+      # itself, use that
+      elsif object.type_info
+        # If the parameter name includes the default value, scrub that.
+        if param[:name].match(/([^=]*)=/)
+          param_name = $1
+        else
+          param_name = param[:name]
+        end
+        # Collect all the possible types from the object. If no such type
+        # exists for this parameter name don't do anything.
+        possible_types = object.type_info.map {
+          |sig| sig[param_name] or nil
+        }.compact
+
+        # If no possible types could be determined, put the type down as
+        # Unknown
+        if possible_types == []
+          result << "(" << "<tt>Unknown</tt>" << ")"
+        else
+          result << "(" << "<tt>" << possible_types.join(", ") << "</tt>" << ")"
+        end
+      # Give up. It can probably be anything.
       elsif !param[:puppet_3_func]
-        result << "(<tt>TBD</tt>)"
+        result << "(<tt>Unkown</tt>)"
       end
 
       result << "</span>"

lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_details_list.erb

@@ -45,7 +45,7 @@
       <p class="tag_title">Parameters:</p>
       <div class="tags">
         <ul class="param">
-          <%= @html_helper.generate_parameters(func[:params]) %>
+          <%= @html_helper.generate_parameters(func[:params], object.child) %>
         </ul>
       </div>
     <% end %>