Commit bca4add1 authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Rendering return doc for methods.

parent 749b53ec
Loading
Loading
Loading
Loading
+20 −4
Original line number Diff line number Diff line
@@ -16,18 +16,34 @@ module JsDuck
      @short_params.render(item[:params]) + " : " + return_type(item)
    end

    def return_type(item)
      item[:return] ? (item[:return][:type] || "void") : "void"
    end

    def extra_doc(item)
      [
        "<div class='mdetail-params'>",
        "<strong>Parameters:</strong>",
        @long_params.render(item[:params]),
        "<strong>Returns:</strong>",
        render_return(item),
        "</div>"
      ].join("\n")
    end

    def render_return(item)
      type = return_type(item)
      doc = return_doc(item)
      if type == "void" && doc.length == 0
        "<ul><li>void</li></ul>"
      else
        "<ul><li><code>#{type}</code><div class='sub-desc'>#{doc}</div></li></ul>"
      end
    end

    def return_type(item)
      item[:return] ? (item[:return][:type] || "void") : "void"
    end

    def return_doc(item)
      item[:return] ? (item[:return][:doc] || "") : ""
    end
  end

end