Merge pull request #9 from jonasoberschweiber/master

Support option hashes for all arguments.
rubyworks · Oct 11, 2012 · 59f7ece · 59f7ece
2 parents 63ebccf + 5dc87fe
commit 59f7ece
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/lib/yard-tomdoc.rb b/lib/yard-tomdoc.rb
@@ -37,9 +37,9 @@ def self.yard_parse(yard, comment)
       # TODO: how to figure-out class of argument ?
       tomdoc.arguments.each {|arg| yard.create_tag(:param, "#{arg.name} #{arg.description}") }
 
-      if last_argument = tomdoc.arguments.last
+      tomdoc.arguments.each do |arg|
-        last_argument.options.each do |opt|
+        arg.options.each do |opt|
-          yard.create_tag(:option, "#{last_argument.name} #{opt.description}")
+          yard.create_tag(:option, "#{arg.name} #{opt.name} #{opt.description}")
         end
       end
 

diff --git a/test/unit/test_docstring.rb b/test/unit/test_docstring.rb
@@ -19,6 +19,9 @@
 # 
 # text  - The String to be duplicated.
 # count - The Integer number of times to duplicate the text.
+# options - Options (default: {})
+#         :a - Option a
+#         :b - Option b
 # 
 # Examples
 #   multiplex('Tom', 4)
@@ -38,9 +41,21 @@
 
   it "should fill param tags" do
     tags = @docstring.tags(:param)
-    tags.size.assert == 2
+    tags.size.assert == 3
     tags[0].name.assert == 'text'
     tags[1].name.assert == 'count'
+    tags[2].name.assert == 'options'
+  end
+
+  it "should fill options tags" do
+    tags = @docstring.tags(:option)
+    tags.size.assert == 2
+    tags[0].name.assert == 'options'
+    tags[0].pair.name.assert == ':a'
+    tags[0].pair.text.assert == 'Option a'
+    tags[1].name.assert == 'options'
+    tags[1].pair.name.assert == ':b'
+    tags[1].pair.text.assert == 'Option b'
   end
 
   it "should fill examples tags" do