yard-docco 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.0.1 / 2011-08-01
+
+- FIX an issue with some inline comments not appearing
+
 === 1.0.0 / 2011-07-31
 
 * Initial Release

data/example/annotated_source.rb

@@ -1,20 +1,38 @@
+# An example pirate ship.
 class Example
   
-  def to_s
+  # @todo Yar! There be comments ahead, within these method. And if you are wise 
+  #   you will view the annotated source.
+  def a_word_of_warning
     
-    # Comments at the start of will be collected with the comments below and
-    # all notes and todos will be above even this.
-    # @note that I want to tell you something
-    # @todo this is a todo
-    # This sentence was below the @note and the @todo but will appear with the
-    # other sentences below them.
+    # Comments are found and collected and matched to the code that immediately
+    # follows the comments. You will be able to see these comments to the left
+    # of the source code that follows
     self.to_s.capitalize
+  end
+
+  # You must have stolen a pirate's rum to have been given this fate.
+  def walk_the_plank
     
-    # Some comments at the end that should get included as well
+    # @note A note should be parsed and appear in the comments. Which will make
+    #   it easier to find code that needs to be addressed.
+    puts "Yo Ho, Yo Ho!"
+    
+    # I should have listened to the {#a_word_of_warning} (which I can link to
+    # and visit immediately from within the method comments).  Too late.
+    puts "Walk the Plank!"
+
+    # @todo Even todo tags will appear as well. This todo is telling me I should
+    #   code up the plank to walk.
+    # 
+    # No code follows save for the end of the method, but the comment should still 
+    # appear paired with a block of code.
     
   end
   
   #
+  # What? Even pirate ships need to export to XML.
+  # 
   # Create an xml representation of the specified class based on defined
   # HappyMapper elements and attributes. The method is defined in a way
   # that it can be called recursively by classes that are also HappyMapper

data/lib/yard-docco.rb

@@ -1,5 +1,5 @@
 module DoccoInTheYARD
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end
 
 YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/../templates'

data/templates/default/method_details/html/annotated_source.erb

@@ -7,7 +7,7 @@
   <% object.annotated_source.each do |source| %>
     <tr>
       <td class="comment">
-        <span><%= docstring_comment Array(source.first).join("\n") %>  
+        <span><%= docstring_comment source.first %>  
       </td>
       <td class="line-numbers">
         <pre class="lines" style="padding-right: 0px;"><%= h show_annotated_lines(source) %></pre>

data/templates/default/method_details/html/setup.rb

@@ -104,7 +104,7 @@ def annotate_source(source)
   # If we have finished parsing lines and we still have code within a home, which
   # is likely if the the source code ends with an end. We want to create a new pair
   if current_code
-    annotated << [ finished_comment.to_s, current_code ]
+    annotated << [ finished_comment, current_code ]
     current_code = nil
   end
   

metadata

@@ -2,7 +2,7 @@
 name: yard-docco
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Franklin Webber
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-31 00:00:00 -07:00
+date: 2011-08-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,7 @@ homepage: http://github.com/burtlo/yard-docco
 licenses: []
 
 post_install_message: "\n\
-  (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==)\n\n  Thank you for installing yard-docco 1.0.0 / 2011-07-31.\n  \n  Changes:\n    \n  * Initial Release\n\
+  (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==)\n\n  Thank you for installing yard-docco 1.0.1 / 2011-08-01.\n  \n  Changes:\n    \n  - FIX an issue with some inline comments not appearing\n  \n\n\
   (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==)\n\n"
 rdoc_options: 
 - --charset=UTF-8