From 4c2cdec78677663350318ac5fd854188528f5a26 Mon Sep 17 00:00:00 2001
From: Rene Saarsoo <nene@triin.net>
Date: Sun, 5 Dec 2010 20:33:26 +0200
Subject: [PATCH] Optional method parameters rendered in brackets.

---
 lib/jsduck/table.rb | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/lib/jsduck/table.rb b/lib/jsduck/table.rb
index df79e1e1..1af2119e 100644
--- a/lib/jsduck/table.rb
+++ b/lib/jsduck/table.rb
@@ -47,10 +47,22 @@ module JsDuck
 
     # Creates parameter list used in method and event signature.
     def short_param_list(item)
+      if item[:params].length == 0
+        return "()"
+      end
+
       params = item[:params].collect do |p|
-        (p[:type] || "Object") + " " + (p[:name] || "")
+        type = p[:type] || "Object"
+        name = p[:name] || ""
+        str = "<code>#{type} #{name}</code>"
+        if p[:doc] =~ /\(optional\)/
+          "<span title='Optional' class='optional'>[" + str + "]</span>"
+        else
+          str
+        end
       end
-      return params.length > 0 ? ("( " + params.join(", ") + " )") : "()"
+
+      return "( " + params.join(", ") + " )"
     end
 
     # 116 chars is also where ext-doc makes its cut, but unlike
-- 
GitLab