yard 0.4.0 → 0.5.0

data/templates/default/module/html/method_summary.erb

@@ -1,8 +1,9 @@
-<% if method_listing.size > 0 %>
-  <h2>Method Summary</h2>
+<% scopes(method_listing) do |list, scope| %>
+  <h2><%= scope.to_s.capitalize %> Method Summary</h2>
+
   <ul class="summary">
-    <% method_listing.each do |meth| %>
+    <% list.each do |meth| %>
       <%= yieldall :item => meth %>
     <% end %>
   </ul>
-<% end %>
+<% end %>

data/templates/default/module/html/methodmissing.erb

@@ -1,4 +1,4 @@
-<div id="method_missing_details">
+<div id="method_missing_details" class="method_details_list">
   <h2>Dynamic Method Handling</h2>
   <p class="notice <%= @mm.namespace == object ? 'this' : 'super' %>">
     This class handles dynamic methods through the <tt>method_missing</tt> method

data/templates/default/module/setup.rb

@@ -21,8 +21,8 @@ def children
     @inner[0][1] << child if child.type == :module
     @inner[1][1] << child if child.type == :class
   end
+  @inner.map! {|v| [v[0], run_verifier(v[1].sort_by {|o| o.name.to_s })] }
   return if (@inner[0][1].size + @inner[1][1].size) == 0
-  @inner.map! {|v| [v[0], v[1].sort_by {|o| o.name.to_s }] }
   erb(:children)
 end
 
@@ -33,15 +33,17 @@ def methodmissing
 end
 
 def method_listing(include_specials = true)
-  return @smeths ||= method_listing.reject {|o| special_methods.include? o.name(true) } unless include_specials
+  return @smeths ||= method_listing.reject {|o| special_method?(o) } unless include_specials
   return @meths if @meths
   @meths = object.meths(:inherited => false, :included => false)
   @meths = sort_listing(prune_method_listing(@meths))
   @meths
 end
 
-def special_methods
-  ["#initialize", "#method_missing"]
+def special_method?(meth)
+  return true if meth.name(true) == '#method_missing'
+  return true if meth.constructor?
+  false
 end
 
 def attr_listing
@@ -64,7 +66,7 @@ def constant_listing
 end
 
 def sort_listing(list)
-  list.sort_by {|o| [o.scope, (options[:visibilities]||[]).index(o.visibility), o.name].join(":") }
+  list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
 end
 
 def docstring_summary(obj)
@@ -81,3 +83,10 @@ def docstring_summary(obj)
 
   docstring.summary
 end
+
+def scopes(list)
+  [:class, :instance].each do |scope|
+    items = list.select {|m| m.scope == scope }
+    yield(items, scope) unless items.empty?
+  end
+end

data/templates/default/tags/html/overload.erb

@@ -1,11 +1,12 @@
 <% if object.tags(:overload).size == 1 %>
   <%= yieldall :object => object.tag(:overload) %>
-<% elsif object.has_tag?(:overload) %>
+<% elsif object.has_tag?(:overload) && object.tags(:overload).any? {|o| !o.docstring.blank? } %>
   <h3>Overloads:</h3>
   <ul class="overload">
     <% object.tags(:overload).each do |overload| %>
+      <% next if overload.docstring.blank? %>
       <li class="overload_item">
-        <span class="signature"><%= signature(overload, false) %></span>
+        <span class="signature"><%= signature(overload, false, false) %></span>
         <%= yieldall :object => overload %>
       </li>
     <% end %>

data/templates/default/tags/setup.rb

@@ -20,6 +20,10 @@ def yieldreturn
 end
 
 def return
+  if object.type == :method
+    return if object.name == :initialize && object.scope == :instance
+    return if object.tags(:return).size == 1 && object.tag(:return).types == ['void']
+  end
   tag :return, :no_names => true
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yard
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Loren Segal
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-15 00:00:00 -05:00
+date: 2009-12-13 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -43,8 +43,10 @@ files:
 - bin/yri
 - lib/rubygems_plugin.rb
 - lib/yard/autoload.rb
+- lib/yard/cli/base.rb
 - lib/yard/cli/yard_graph.rb
 - lib/yard/cli/yardoc.rb
+- lib/yard/cli/yri.rb
 - lib/yard/code_objects/base.rb
 - lib/yard/code_objects/class_object.rb
 - lib/yard/code_objects/class_variable_object.rb
@@ -57,6 +59,7 @@ files:
 - lib/yard/code_objects/root_object.rb
 - lib/yard/core_ext/array.rb
 - lib/yard/core_ext/file.rb
+- lib/yard/core_ext/hash.rb
 - lib/yard/core_ext/module.rb
 - lib/yard/core_ext/string.rb
 - lib/yard/core_ext/symbol_hash.rb
@@ -93,6 +96,7 @@ files:
 - lib/yard/handlers/ruby/visibility_handler.rb
 - lib/yard/handlers/ruby/yield_handler.rb
 - lib/yard/logging.rb
+- lib/yard/parser/c_parser.rb
 - lib/yard/parser/ruby/ast_node.rb
 - lib/yard/parser/ruby/legacy/ruby_lex.rb
 - lib/yard/parser/ruby/legacy/statement.rb
@@ -102,10 +106,12 @@ files:
 - lib/yard/parser/source_parser.rb
 - lib/yard/rake/yardoc_task.rb
 - lib/yard/registry.rb
+- lib/yard/registry_store.rb
 - lib/yard/serializers/base.rb
 - lib/yard/serializers/file_system_serializer.rb
 - lib/yard/serializers/process_serializer.rb
 - lib/yard/serializers/stdout_serializer.rb
+- lib/yard/serializers/yardoc_serializer.rb
 - lib/yard/tags/default_factory.rb
 - lib/yard/tags/default_tag.rb
 - lib/yard/tags/library.rb
@@ -130,6 +136,7 @@ files:
 - lib/yard/verifier.rb
 - lib/yard.rb
 - spec/cli/yardoc_spec.rb
+- spec/cli/yri_spec.rb
 - spec/code_objects/base_spec.rb
 - spec/code_objects/class_object_spec.rb
 - spec/code_objects/code_object_list_spec.rb
@@ -141,6 +148,7 @@ files:
 - spec/code_objects/spec_helper.rb
 - spec/core_ext/array_spec.rb
 - spec/core_ext/file_spec.rb
+- spec/core_ext/hash_spec.rb
 - spec/core_ext/module_spec.rb
 - spec/core_ext/string_spec.rb
 - spec/core_ext/symbol_hash_spec.rb
@@ -179,6 +187,8 @@ files:
 - spec/handlers/spec_helper.rb
 - spec/handlers/visibility_handler_spec.rb
 - spec/handlers/yield_handler_spec.rb
+- spec/parser/c_parser_spec.rb
+- spec/parser/examples/array.c.txt
 - spec/parser/examples/example1.rb.txt
 - spec/parser/examples/parse_in_order_001.rb.txt
 - spec/parser/examples/parse_in_order_002.rb.txt
@@ -191,6 +201,7 @@ files:
 - spec/parser/tag_parsing_spec.rb
 - spec/rake/yardoc_task_spec.rb
 - spec/registry_spec.rb
+- spec/registry_store_spec.rb
 - spec/serializers/file_system_serializer_spec.rb
 - spec/serializers/spec_helper.rb
 - spec/spec_helper.rb
@@ -209,6 +220,10 @@ files:
 - spec/templates/examples/method002.txt
 - spec/templates/examples/method003.html
 - spec/templates/examples/method003.txt
+- spec/templates/examples/method004.html
+- spec/templates/examples/method004.txt
+- spec/templates/examples/method005.html
+- spec/templates/examples/method005.txt
 - spec/templates/examples/module001.dot
 - spec/templates/examples/module001.html
 - spec/templates/examples/module001.txt
@@ -217,6 +232,9 @@ files:
 - spec/templates/helpers/html_helper_spec.rb
 - spec/templates/helpers/html_syntax_highlight_helper_spec.rb
 - spec/templates/helpers/markup_helper_spec.rb
+- spec/templates/helpers/method_helper_spec.rb
+- spec/templates/helpers/shared_signature_examples.rb
+- spec/templates/helpers/text_helper_spec.rb
 - spec/templates/method_spec.rb
 - spec/templates/module_spec.rb
 - spec/templates/spec_helper.rb
@@ -236,6 +254,7 @@ files:
 - templates/default/docstring/html/deprecated.erb
 - templates/default/docstring/html/index.erb
 - templates/default/docstring/html/note.erb
+- templates/default/docstring/html/returns_void.erb
 - templates/default/docstring/html/text.erb
 - templates/default/docstring/html/todo.erb
 - templates/default/docstring/setup.rb
@@ -243,6 +262,7 @@ files:
 - templates/default/docstring/text/deprecated.erb
 - templates/default/docstring/text/index.erb
 - templates/default/docstring/text/note.erb
+- templates/default/docstring/text/returns_void.erb
 - templates/default/docstring/text/text.erb
 - templates/default/docstring/text/todo.erb
 - templates/default/fulldoc/html/css/common.css
@@ -328,6 +348,7 @@ files:
 - benchmarks/template_erb.rb
 - benchmarks/template_format.rb
 - benchmarks/template_profile.rb
+- benchmarks/yri_cache.rb
 - ChangeLog
 - LICENSE
 - README.md