yard 0.2.2 → 0.2.3

data/templates/default/tags/text/option.erb

@@ -0,0 +1,5 @@
+  - Options hash <%= param %>:
+<% for tag in object.tags(:option).select {|x| x.name.to_s == param } %>
+    - <%= format_types (tag.pair.types || ['Object']) %> <%= tag.pair.name %> <%  %><%= tag.pair.defaults.map {|t| "(defaults to #{t})" }.join(", ") if tag.pair.defaults %> <%= tag.pair.text %>
+<% end %>
+

data/templates/default/tags/text/param.erb

@@ -0,0 +1,9 @@
+> <%= YARD::Tags::Library.labels[:param] %>:
+<% for tag in tags_by_param(object) %>
+<% if tag.is_a?(YARD::Tags::OptionTag) %>
+<%= render object, 'option', :param => tag.name.to_s %>
+<% else %>
+  - <%= format_types (tag.types || ['Object']) %> <%= h tag.name %> <% if (o=object.parameters.assoc(tag.name.to_sym)) && o[1] %>(defaults to: <%= h o[1] %>)<% end %>
+<%= "    " + tag.text if tag.text %>
+<% end %>
+<% end %>

data/templates/default/uml/dot/dependencies.erb

@@ -7,4 +7,4 @@
     <% end %>
     <%= !format_path(obj).empty? ? format_path(obj) : "Kernel" %> -> <%= format_path depobj %> [style=dashed rank=sink];
   <% end %>
-<% end %>
+<% end %>

data/templates/default/uml/dot/info.erb

@@ -1,7 +1,7 @@
 <%= object.type %> <%= h object.name %>
 <% if show_full_info? %>
 |
-<% object.namespace.attributes.each do |scope, list| %>
+<% object.attributes.each do |scope, list| %>
 <% list.each do |name, rw| %>
 <%= uml_visibility(rw.values.compact.first) %> <%= h rw.values.compact.first.name(true) %> [<%= 'R' if rw[:read] %><%= 'W' if rw[:write] %>]\l
 <% end %>

data/templates/default/uml/dot/superclasses.erb

@@ -1,5 +1,5 @@
-<% for obj in @objects.select {|o| CodeObjects::ClassObject === o && o.superclass != P(:Object) } %>
-  <% [obj, obj.superclass].each do |o| %>
+<% for obj in @objects.select {|o| CodeObjects::ClassObject === o && o.superclass && o.superclass != P(:Object) } %>
+  <% [obj, obj.superclass].compact.each do |o| %>
     <% if o != Registry.root && (!o.respond_to?(:children) || !namespaces(o).empty?) %>
       <%= format_path o %> [label="{<%= o.type %> <%= o.path %>}" rank=sink];
     <% end %>

data/templates/javadoc/methodsummary/html/summary.erb

@@ -11,9 +11,9 @@
           <span class='block'><%= format_block meth %></span>
         </tt>
         <span class="indent">
-          <% if meth.short_docstring %>
+          <% unless meth.docstring.summary.empty? %>
             <br />
-            &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<%= meth.short_docstring %>
+            &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<%= meth.docstring.summary %>
           <% end %>
           <% if meth.has_tag?(:deprecated) %>
           <br /><strong>Deprecated.</strong> <em><%= meth.tag(:deprecated).text %></em>

data/templates/javadoc/mixins/html/header.erb

@@ -1,5 +1,5 @@
 <div class="section <%= generator_name %>">
-  <strong>All Included Modules:</strong>
-  <p><%= object.mixins.map {|o| linkify o }.join(", ") %></p>
+  <strong><%= scope == :instance ? "Included" : "Extended" %> Modules:</strong>
+  <p><%= object.mixins(scope).map {|o| linkify o }.join(", ") %></p>
 </div>
-<hr />
+<hr />

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yard
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Loren Segal
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-16 00:00:00 -04:00
+date: 2009-06-07 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -24,32 +24,44 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- docs/CODE_OBJECTS.markdown
+- docs/FAQ.markdown
+- docs/GENERATORS.markdown
+- docs/GETTING_STARTED.markdown
+- docs/GLOSSARY.markdown
+- docs/HANDLERS.markdown
+- docs/images/code-objects-class-diagram.png
+- docs/images/handlers-class-diagram.png
+- docs/images/overview-class-diagram.png
+- docs/images/parser-class-diagram.png
+- docs/images/tags-class-diagram.png
+- docs/OVERVIEW.markdown
+- docs/PARSER.markdown
+- docs/TAGS.markdown
+- docs/WHATSNEW.markdown
 - bin/view_generator
 - bin/yard-graph
 - bin/yardoc
 - bin/yri
-- lib/yard
 - lib/yard/autoload.rb
-- lib/yard/cli
 - lib/yard/cli/yard_graph.rb
 - lib/yard/cli/yardoc.rb
-- lib/yard/code_objects
 - lib/yard/code_objects/base.rb
 - lib/yard/code_objects/class_object.rb
 - lib/yard/code_objects/class_variable_object.rb
 - lib/yard/code_objects/constant_object.rb
+- lib/yard/code_objects/extended_method_object.rb
 - lib/yard/code_objects/method_object.rb
 - lib/yard/code_objects/module_object.rb
 - lib/yard/code_objects/namespace_object.rb
 - lib/yard/code_objects/proxy.rb
 - lib/yard/code_objects/root_object.rb
-- lib/yard/core_ext
 - lib/yard/core_ext/file.rb
 - lib/yard/core_ext/logger.rb
 - lib/yard/core_ext/module.rb
 - lib/yard/core_ext/string.rb
 - lib/yard/core_ext/symbol_hash.rb
-- lib/yard/generators
+- lib/yard/docstring.rb
 - lib/yard/generators/attributes_generator.rb
 - lib/yard/generators/base.rb
 - lib/yard/generators/class_generator.rb
@@ -58,10 +70,11 @@ files:
 - lib/yard/generators/deprecated_generator.rb
 - lib/yard/generators/docstring_generator.rb
 - lib/yard/generators/full_doc_generator.rb
-- lib/yard/generators/helpers
 - lib/yard/generators/helpers/base_helper.rb
 - lib/yard/generators/helpers/filter_helper.rb
 - lib/yard/generators/helpers/html_helper.rb
+- lib/yard/generators/helpers/html_syntax_highlight_helper.rb
+- lib/yard/generators/helpers/markup_helper.rb
 - lib/yard/generators/helpers/method_helper.rb
 - lib/yard/generators/helpers/uml_helper.rb
 - lib/yard/generators/inheritance_generator.rb
@@ -73,46 +86,68 @@ files:
 - lib/yard/generators/method_summary_generator.rb
 - lib/yard/generators/mixins_generator.rb
 - lib/yard/generators/module_generator.rb
+- lib/yard/generators/overloads_generator.rb
 - lib/yard/generators/quick_doc_generator.rb
+- lib/yard/generators/root_generator.rb
 - lib/yard/generators/source_generator.rb
 - lib/yard/generators/tags_generator.rb
 - lib/yard/generators/uml_generator.rb
 - lib/yard/generators/visibility_group_generator.rb
-- lib/yard/handlers
-- lib/yard/handlers/alias_handler.rb
-- lib/yard/handlers/attribute_handler.rb
 - lib/yard/handlers/base.rb
-- lib/yard/handlers/class_handler.rb
-- lib/yard/handlers/class_variable_handler.rb
-- lib/yard/handlers/constant_handler.rb
-- lib/yard/handlers/exception_handler.rb
-- lib/yard/handlers/method_handler.rb
-- lib/yard/handlers/mixin_handler.rb
-- lib/yard/handlers/module_handler.rb
-- lib/yard/handlers/visibility_handler.rb
-- lib/yard/handlers/yield_handler.rb
+- lib/yard/handlers/processor.rb
+- lib/yard/handlers/ruby/alias_handler.rb
+- lib/yard/handlers/ruby/attribute_handler.rb
+- lib/yard/handlers/ruby/base.rb
+- lib/yard/handlers/ruby/class_condition_handler.rb
+- lib/yard/handlers/ruby/class_handler.rb
+- lib/yard/handlers/ruby/class_variable_handler.rb
+- lib/yard/handlers/ruby/constant_handler.rb
+- lib/yard/handlers/ruby/exception_handler.rb
+- lib/yard/handlers/ruby/extend_handler.rb
+- lib/yard/handlers/ruby/legacy/alias_handler.rb
+- lib/yard/handlers/ruby/legacy/attribute_handler.rb
+- lib/yard/handlers/ruby/legacy/base.rb
+- lib/yard/handlers/ruby/legacy/class_handler.rb
+- lib/yard/handlers/ruby/legacy/class_variable_handler.rb
+- lib/yard/handlers/ruby/legacy/constant_handler.rb
+- lib/yard/handlers/ruby/legacy/exception_handler.rb
+- lib/yard/handlers/ruby/legacy/extend_handler.rb
+- lib/yard/handlers/ruby/legacy/method_handler.rb
+- lib/yard/handlers/ruby/legacy/mixin_handler.rb
+- lib/yard/handlers/ruby/legacy/module_handler.rb
+- lib/yard/handlers/ruby/legacy/visibility_handler.rb
+- lib/yard/handlers/ruby/legacy/yield_handler.rb
+- lib/yard/handlers/ruby/method_condition_handler.rb
+- lib/yard/handlers/ruby/method_handler.rb
+- lib/yard/handlers/ruby/mixin_handler.rb
+- lib/yard/handlers/ruby/module_handler.rb
+- lib/yard/handlers/ruby/visibility_handler.rb
+- lib/yard/handlers/ruby/yield_handler.rb
 - lib/yard/logging.rb
-- lib/yard/parser
-- lib/yard/parser/ruby_lex.rb
+- lib/yard/parser/ruby/ast_node.rb
+- lib/yard/parser/ruby/legacy/ruby_lex.rb
+- lib/yard/parser/ruby/legacy/statement.rb
+- lib/yard/parser/ruby/legacy/statement_list.rb
+- lib/yard/parser/ruby/legacy/token_list.rb
+- lib/yard/parser/ruby/ruby_parser.rb
 - lib/yard/parser/source_parser.rb
-- lib/yard/parser/statement.rb
-- lib/yard/parser/statement_list.rb
-- lib/yard/parser/token_list.rb
-- lib/yard/rake
 - lib/yard/rake/yardoc_task.rb
 - lib/yard/registry.rb
-- lib/yard/serializers
 - 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/tags
 - lib/yard/tags/default_factory.rb
+- lib/yard/tags/default_tag.rb
 - lib/yard/tags/library.rb
-- lib/yard/tags/merbdoc_factory.rb
+- lib/yard/tags/option_tag.rb
+- lib/yard/tags/overload_tag.rb
+- lib/yard/tags/ref_tag.rb
+- lib/yard/tags/ref_tag_list.rb
 - lib/yard/tags/tag.rb
+- lib/yard/tags/tag_format_error.rb
 - lib/yard.rb
-- spec/code_objects
+- spec/cli/yardoc_spec.rb
 - spec/code_objects/base_spec.rb
 - spec/code_objects/class_object_spec.rb
 - spec/code_objects/code_object_list_spec.rb
@@ -122,155 +157,131 @@ files:
 - spec/code_objects/namespace_object_spec.rb
 - spec/code_objects/proxy_spec.rb
 - spec/code_objects/spec_helper.rb
-- spec/core_ext
 - spec/core_ext/file_spec.rb
 - spec/core_ext/string_spec.rb
 - spec/core_ext/symbol_hash_spec.rb
-- spec/generators
+- spec/docstring_spec.rb
 - spec/generators/base_spec.rb
-- spec/generators/helpers
+- spec/generators/full_doc_generator_spec.rb
 - spec/generators/helpers/base_helper_spec.rb
 - spec/generators/helpers/html_helper_spec.rb
+- spec/generators/helpers/markup_helper_spec.rb
 - spec/generators/quick_doc_generator_spec.rb
-- spec/handlers
 - spec/handlers/alias_handler_spec.rb
 - spec/handlers/attribute_handler_spec.rb
 - spec/handlers/base_spec.rb
+- spec/handlers/class_condition_handler_spec.rb
 - spec/handlers/class_handler_spec.rb
 - spec/handlers/class_variable_handler_spec.rb
 - spec/handlers/constant_handler_spec.rb
-- spec/handlers/examples
 - spec/handlers/examples/alias_handler_001.rb.txt
 - spec/handlers/examples/attribute_handler_001.rb.txt
+- spec/handlers/examples/class_condition_handler_001.rb.txt
 - spec/handlers/examples/class_handler_001.rb.txt
 - spec/handlers/examples/class_variable_handler_001.rb.txt
 - spec/handlers/examples/constant_handler_001.rb.txt
 - spec/handlers/examples/exception_handler_001.rb.txt
+- spec/handlers/examples/extend_handler_001.rb.txt
+- spec/handlers/examples/method_condition_handler_001.rb.txt
 - spec/handlers/examples/method_handler_001.rb.txt
 - spec/handlers/examples/mixin_handler_001.rb.txt
 - spec/handlers/examples/module_handler_001.rb.txt
 - spec/handlers/examples/visibility_handler_001.rb.txt
 - spec/handlers/examples/yield_handler_001.rb.txt
 - spec/handlers/exception_handler_spec.rb
+- spec/handlers/extend_handler_spec.rb
+- spec/handlers/legacy_base_spec.rb
+- spec/handlers/method_condition_handler_spec.rb
 - spec/handlers/method_handler_spec.rb
 - spec/handlers/mixin_handler_spec.rb
 - spec/handlers/module_handler_spec.rb
+- spec/handlers/processor_spec.rb
+- spec/handlers/ruby/base_spec.rb
+- spec/handlers/ruby/legacy/base_spec.rb
 - spec/handlers/spec_helper.rb
 - spec/handlers/visibility_handler_spec.rb
 - spec/handlers/yield_handler_spec.rb
-- spec/parser
-- spec/parser/examples
 - spec/parser/examples/example1.rb.txt
 - spec/parser/examples/tag_handler_001.rb.txt
+- spec/parser/ruby/ast_node_spec.rb
+- spec/parser/ruby/legacy/statement_list_spec.rb
+- spec/parser/ruby/legacy/token_list_spec.rb
 - spec/parser/source_parser_spec.rb
 - spec/parser/tag_parsing_spec.rb
-- spec/parser/token_list_spec.rb
+- spec/rake/yardoc_task_spec.rb
 - spec/registry_spec.rb
-- spec/serializers
 - spec/serializers/file_system_serializer_spec.rb
 - spec/serializers/spec_helper.rb
 - spec/spec_helper.rb
-- spec/tags
-- templates/default
-- templates/default/attributes
-- templates/default/attributes/html
+- spec/tags/default_factory_spec.rb
+- spec/tags/default_tag_spec.rb
+- spec/tags/overload_tag_spec.rb
+- spec/tags/ref_tag_list_spec.rb
 - templates/default/attributes/html/header.erb
-- templates/default/attributes/text
 - templates/default/attributes/text/header.erb
-- templates/default/class
-- templates/default/class/html
 - templates/default/class/html/header.erb
-- templates/default/constants
-- templates/default/constants/html
 - templates/default/constants/html/constants.erb
 - templates/default/constants/html/header.erb
 - templates/default/constants/html/included.erb
 - templates/default/constants/html/inherited.erb
-- templates/default/constructor
-- templates/default/constructor/html
 - templates/default/constructor/html/header.erb
-- templates/default/deprecated
-- templates/default/deprecated/html
 - templates/default/deprecated/html/main.erb
-- templates/default/deprecated/text
 - templates/default/deprecated/text/main.erb
-- templates/default/docstring
-- templates/default/docstring/html
 - templates/default/docstring/html/main.erb
-- templates/default/docstring/text
 - templates/default/docstring/text/main.erb
-- templates/default/fulldoc
-- templates/default/fulldoc/html
+- templates/default/fulldoc/html/all_files.erb
 - templates/default/fulldoc/html/all_methods.erb
 - templates/default/fulldoc/html/all_namespaces.erb
 - templates/default/fulldoc/html/app.js
+- templates/default/fulldoc/html/file.erb
 - templates/default/fulldoc/html/header.erb
 - templates/default/fulldoc/html/html_head.erb
 - templates/default/fulldoc/html/index.erb
 - templates/default/fulldoc/html/jquery.js
-- templates/default/fulldoc/html/readme.erb
 - templates/default/fulldoc/html/style.css
 - templates/default/fulldoc/html/syntax_highlight.css
-- templates/default/inheritance
-- templates/default/inheritance/html
 - templates/default/inheritance/html/header.erb
-- templates/default/inheritance/text
 - templates/default/inheritance/text/header.erb
-- templates/default/method
-- templates/default/method/html
 - templates/default/method/html/aliases.erb
 - templates/default/method/html/header.erb
 - templates/default/method/html/title.erb
-- templates/default/methoddetails
-- templates/default/methoddetails/html
+- templates/default/method/text/header.erb
+- templates/default/method/text/title.erb
 - templates/default/methoddetails/html/header.erb
 - templates/default/methoddetails/html/method_header.erb
-- templates/default/methodmissing
-- templates/default/methodmissing/html
 - templates/default/methodmissing/html/header.erb
-- templates/default/methodsignature
-- templates/default/methodsignature/html
 - templates/default/methodsignature/html/main.erb
-- templates/default/methodsignature/text
 - templates/default/methodsignature/text/main.erb
-- templates/default/methodsummary
-- templates/default/methodsummary/html
 - templates/default/methodsummary/html/header.erb
 - templates/default/methodsummary/html/included.erb
 - templates/default/methodsummary/html/inherited.erb
 - templates/default/methodsummary/html/summary.erb
-- templates/default/methodsummary/text
 - templates/default/methodsummary/text/header.erb
 - templates/default/methodsummary/text/included.erb
 - templates/default/methodsummary/text/inherited.erb
 - templates/default/methodsummary/text/summary.erb
-- templates/default/mixins
-- templates/default/mixins/html
 - templates/default/mixins/html/header.erb
-- templates/default/module
-- templates/default/module/html
 - templates/default/module/html/header.erb
-- templates/default/quickdoc
-- templates/default/quickdoc/html
+- templates/default/overloads/html/header.erb
+- templates/default/overloads/text/header.erb
 - templates/default/quickdoc/html/header.erb
-- templates/default/quickdoc/text
 - templates/default/quickdoc/text/header.erb
-- templates/default/source
-- templates/default/source/html
+- templates/default/root/html/header.erb
 - templates/default/source/html/main.erb
-- templates/default/source/text
 - templates/default/source/text/main.erb
-- templates/default/tags
-- templates/default/tags/html
+- templates/default/tags/html/example.erb
 - templates/default/tags/html/header.erb
+- templates/default/tags/html/option.erb
+- templates/default/tags/html/param.erb
 - templates/default/tags/html/see.erb
 - templates/default/tags/html/tags.erb
-- templates/default/tags/text
+- templates/default/tags/html/todo.erb
+- templates/default/tags/text/example.erb
 - templates/default/tags/text/header.erb
+- templates/default/tags/text/option.erb
+- templates/default/tags/text/param.erb
 - templates/default/tags/text/see.erb
 - templates/default/tags/text/tags.erb
-- templates/default/uml
-- templates/default/uml/dot
 - templates/default/uml/dot/child.erb
 - templates/default/uml/dot/dependencies.erb
 - templates/default/uml/dot/header.erb
@@ -279,41 +290,16 @@ files:
 - templates/default/uml/dot/superclasses.erb
 - templates/default/uml/dot/unknown.erb
 - templates/default/uml/dot/unknown_child.erb
-- templates/default/visibilitygroup
-- templates/default/visibilitygroup/html
 - templates/default/visibilitygroup/html/header.erb
-- templates/fulldoc
-- templates/fulldoc/html
-- templates/fulldoc/html/module
-- templates/fulldoc/html/module/attributes
-- templates/fulldoc/html/module/constants
-- templates/fulldoc/html/module/meth_missing
-- templates/fulldoc/html/module/mixins
-- templates/fulldoc/html/module/visibility
-- templates/javadoc
-- templates/javadoc/attributes
-- templates/javadoc/attributes/html
 - templates/javadoc/attributes/html/header.erb
-- templates/javadoc/class
-- templates/javadoc/class/html
 - templates/javadoc/class/html/header.erb
-- templates/javadoc/constants
-- templates/javadoc/constants/html
 - templates/javadoc/constants/html/constants.erb
 - templates/javadoc/constants/html/header.erb
 - templates/javadoc/constants/html/included.erb
 - templates/javadoc/constants/html/inherited.erb
-- templates/javadoc/constructor
-- templates/javadoc/constructor/html
 - templates/javadoc/constructor/html/header.erb
-- templates/javadoc/deprecated
-- templates/javadoc/deprecated/html
 - templates/javadoc/deprecated/html/main.erb
-- templates/javadoc/docstring
-- templates/javadoc/docstring/html
 - templates/javadoc/docstring/html/main.erb
-- templates/javadoc/fulldoc
-- templates/javadoc/fulldoc/html
 - templates/javadoc/fulldoc/html/all_methods.erb
 - templates/javadoc/fulldoc/html/all_namespaces.erb
 - templates/javadoc/fulldoc/html/app.js
@@ -324,56 +310,39 @@ files:
 - templates/javadoc/fulldoc/html/readme.erb
 - templates/javadoc/fulldoc/html/style.css
 - templates/javadoc/fulldoc/html/syntax_highlight.css
-- templates/javadoc/inheritance
-- templates/javadoc/inheritance/html
 - templates/javadoc/inheritance/html/header.erb
-- templates/javadoc/method
-- templates/javadoc/method/html
 - templates/javadoc/method/html/aliases.erb
 - templates/javadoc/method/html/header.erb
 - templates/javadoc/method/html/title.erb
-- templates/javadoc/methoddetails
-- templates/javadoc/methoddetails/html
 - templates/javadoc/methoddetails/html/header.erb
 - templates/javadoc/methoddetails/html/method_header.erb
-- templates/javadoc/methodmissing
-- templates/javadoc/methodmissing/html
 - templates/javadoc/methodmissing/html/header.erb
-- templates/javadoc/methodsignature
-- templates/javadoc/methodsignature/html
 - templates/javadoc/methodsignature/html/main.erb
-- templates/javadoc/methodsummary
-- templates/javadoc/methodsummary/html
 - templates/javadoc/methodsummary/html/header.erb
 - templates/javadoc/methodsummary/html/included.erb
 - templates/javadoc/methodsummary/html/inherited.erb
 - templates/javadoc/methodsummary/html/summary.erb
-- templates/javadoc/mixins
-- templates/javadoc/mixins/html
 - templates/javadoc/mixins/html/header.erb
-- templates/javadoc/module
-- templates/javadoc/module/html
 - templates/javadoc/module/html/header.erb
-- templates/javadoc/source
-- templates/javadoc/source/html
 - templates/javadoc/source/html/main.erb
-- templates/javadoc/tags
-- templates/javadoc/tags/html
 - templates/javadoc/tags/html/header.erb
 - templates/javadoc/tags/html/see.erb
 - templates/javadoc/tags/html/tags.erb
-- templates/javadoc/visibilitygroup
-- templates/javadoc/visibilitygroup/html
 - templates/javadoc/visibilitygroup/html/header.erb
 - benchmarks/builtins_vs_eval.rb
 - benchmarks/erb_vs_erubis.rb
+- benchmarks/format_args.rb
 - benchmarks/generation.rb
 - benchmarks/parsing.rb
+- benchmarks/rdoc_vs_yardoc.rb
+- benchmarks/ripper_parser.rb
 - LICENSE
-- README
+- README.markdown
 - Rakefile
 has_rdoc: false
 homepage: http://yard.soen.ca
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -394,9 +363,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yard
-rubygems_version: 1.1.1
+rubygems_version: 1.3.2
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Documentation tool for consistent and usable documentation in Ruby.
 test_files: []