diff --git a/lib/jsduck.rb b/lib/jsduck.rb index 81b3ba6e3345e3a7d52c18749a0fef79f9da6bdd..cb39d80174a14f34e3fa6ccb392aa8df0197969b 100755 --- a/lib/jsduck.rb +++ b/lib/jsduck.rb @@ -10,7 +10,7 @@ require 'jsduck/doc_links' require 'jsduck/table' require 'jsduck/cfg_table' require 'jsduck/property_table' -require 'jsduck/param_list' +require 'jsduck/short_params' require 'jsduck/method_table' require 'jsduck/event_table' require 'jsduck/page' diff --git a/lib/jsduck/event_table.rb b/lib/jsduck/event_table.rb index 16b9f85a475ab29a9cec404be490de15364615bc..d1ebc2667eb20c2d64eae31081a30459ca22dc73 100644 --- a/lib/jsduck/event_table.rb +++ b/lib/jsduck/event_table.rb @@ -8,11 +8,11 @@ module JsDuck @title = "Public Events" @column_title = "Event" @row_class = "method-row" - @param_list = ParamList.new + @short_params = ShortParams.new end def signature_suffix(item) - " : " + @param_list.short(item[:params]) + " : " + @short_params.render(item[:params]) end end diff --git a/lib/jsduck/method_table.rb b/lib/jsduck/method_table.rb index feef3ff6d4bcca8a289967ccf0cbc667d332a184..be94955bc433092e345279d17fe311d5d7989d71 100644 --- a/lib/jsduck/method_table.rb +++ b/lib/jsduck/method_table.rb @@ -8,11 +8,11 @@ module JsDuck @title = "Public Methods" @column_title = "Method" @row_class = "method-row" - @param_list = ParamList.new + @short_params = ShortParams.new end def signature_suffix(item) - @param_list.short(item[:params]) + " : " + return_type(item) + @short_params.render(item[:params]) + " : " + return_type(item) end def return_type(item) diff --git a/lib/jsduck/param_list.rb b/lib/jsduck/short_params.rb similarity index 64% rename from lib/jsduck/param_list.rb rename to lib/jsduck/short_params.rb index 486dc2fcf80c66a475b4d889858a7e0e54d3e2b5..16494655219f56de1e3c55e67d8339bc96267b8f 100644 --- a/lib/jsduck/param_list.rb +++ b/lib/jsduck/short_params.rb @@ -1,17 +1,17 @@ module JsDuck - # Renders method/event parameter lists - class ParamList - # Creates short parameters list used in signatures. - def short(params) + # Renders method/event parameters list in short form + # for use in signatures + class ShortParams + def render(params) if params.length > 0 - "( " + params.collect {|p| format_short(p) }.join(", ") + " )" + "( " + params.collect {|p| render_single(p) }.join(", ") + " )" else "()" end end - def format_short(param) + def render_single(param) type = param[:type] || "Object" name = param[:name] || "" str = "#{type} #{name}"