From 08a1007c6568614ba0fb3cb72025c1d31fe1f4db Mon Sep 17 00:00:00 2001
From: Rene Saarsoo <nene@triin.net>
Date: Sun, 5 Dec 2010 21:09:59 +0200
Subject: [PATCH] Renamed ParamList to ShortParams.

As there is next going to be LongParams.
---
 lib/jsduck.rb                                 |  2 +-
 lib/jsduck/event_table.rb                     |  4 ++--
 lib/jsduck/method_table.rb                    |  4 ++--
 lib/jsduck/{param_list.rb => short_params.rb} | 12 ++++++------
 4 files changed, 11 insertions(+), 11 deletions(-)
 rename lib/jsduck/{param_list.rb => short_params.rb} (64%)

diff --git a/lib/jsduck.rb b/lib/jsduck.rb
index 81b3ba6e..cb39d801 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 16b9f85a..d1ebc266 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 feef3ff6..be94955b 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 486dc2fc..16494655 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 = "<code>#{type} #{name}</code>"
-- 
GitLab