RubyGems - yard - Versions diffs - 0.2.2 → 0.2.3 - Mend

yard 0.2.2 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of yard might be problematic. Click here for more details.

Files changed (204) hide show

data/LICENSE +1 -1
data/README.markdown +200 -0
data/Rakefile +6 -1
data/benchmarks/format_args.rb +46 -0
data/benchmarks/parsing.rb +13 -1
data/benchmarks/rdoc_vs_yardoc.rb +10 -0
data/benchmarks/ripper_parser.rb +12 -0
data/docs/CODE_OBJECTS.markdown +121 -0
data/docs/FAQ.markdown +34 -0
data/docs/GENERATORS.markdown +211 -0
data/docs/GETTING_STARTED.markdown +263 -0
data/docs/GLOSSARY.markdown +13 -0
data/docs/HANDLERS.markdown +158 -0
data/docs/OVERVIEW.markdown +64 -0
data/docs/PARSER.markdown +180 -0
data/docs/TAGS.markdown +181 -0
data/docs/WHATSNEW.markdown +96 -0
data/docs/images/code-objects-class-diagram.png +0 -0
data/docs/images/handlers-class-diagram.png +0 -0
data/docs/images/overview-class-diagram.png +0 -0
data/docs/images/parser-class-diagram.png +0 -0
data/docs/images/tags-class-diagram.png +0 -0
data/lib/yard.rb +4 -1
data/lib/yard/autoload.rb +79 -31
data/lib/yard/cli/yard_graph.rb +8 -2
data/lib/yard/cli/yardoc.rb +61 -8
data/lib/yard/code_objects/base.rb +78 -135
data/lib/yard/code_objects/class_object.rb +9 -8
data/lib/yard/code_objects/constant_object.rb +1 -0
data/lib/yard/code_objects/extended_method_object.rb +9 -0
data/lib/yard/code_objects/method_object.rb +18 -5
data/lib/yard/code_objects/module_object.rb +8 -1
data/lib/yard/code_objects/namespace_object.rb +25 -16
data/lib/yard/code_objects/proxy.rb +22 -22
data/lib/yard/core_ext/file.rb +1 -1
data/lib/yard/core_ext/string.rb +0 -4
data/lib/yard/core_ext/symbol_hash.rb +3 -2
data/lib/yard/docstring.rb +180 -0
data/lib/yard/generators/base.rb +33 -13
data/lib/yard/generators/class_generator.rb +4 -2
data/lib/yard/generators/constants_generator.rb +3 -2
data/lib/yard/generators/full_doc_generator.rb +76 -9
data/lib/yard/generators/helpers/base_helper.rb +18 -1
data/lib/yard/generators/helpers/filter_helper.rb +2 -2
data/lib/yard/generators/helpers/html_helper.rb +94 -39
data/lib/yard/generators/helpers/html_syntax_highlight_helper.rb +49 -0
data/lib/yard/generators/helpers/markup_helper.rb +86 -0
data/lib/yard/generators/helpers/method_helper.rb +23 -7
data/lib/yard/generators/method_generator.rb +15 -3
data/lib/yard/generators/method_listing_generator.rb +3 -3
data/lib/yard/generators/mixins_generator.rb +8 -2
data/lib/yard/generators/module_generator.rb +3 -2
data/lib/yard/generators/overloads_generator.rb +20 -0
data/lib/yard/generators/quick_doc_generator.rb +3 -9
data/lib/yard/generators/root_generator.rb +32 -0
data/lib/yard/generators/source_generator.rb +2 -17
data/lib/yard/generators/tags_generator.rb +34 -6
data/lib/yard/generators/uml_generator.rb +16 -6
data/lib/yard/handlers/base.rb +88 -253
data/lib/yard/handlers/processor.rb +72 -0
data/lib/yard/handlers/ruby/alias_handler.rb +38 -0
data/lib/yard/handlers/ruby/attribute_handler.rb +69 -0
data/lib/yard/handlers/ruby/base.rb +72 -0
data/lib/yard/handlers/ruby/class_condition_handler.rb +70 -0
data/lib/yard/handlers/ruby/class_handler.rb +74 -0
data/lib/yard/handlers/ruby/class_variable_handler.rb +11 -0
data/lib/yard/handlers/ruby/constant_handler.rb +12 -0
data/lib/yard/handlers/ruby/exception_handler.rb +22 -0
data/lib/yard/handlers/ruby/extend_handler.rb +19 -0
data/lib/yard/handlers/{alias_handler.rb → ruby/legacy/alias_handler.rb} +3 -4
data/lib/yard/handlers/{attribute_handler.rb → ruby/legacy/attribute_handler.rb} +2 -2
data/lib/yard/handlers/ruby/legacy/base.rb +198 -0
data/lib/yard/handlers/{class_handler.rb → ruby/legacy/class_handler.rb} +18 -6
data/lib/yard/handlers/{class_variable_handler.rb → ruby/legacy/class_variable_handler.rb} +1 -1
data/lib/yard/handlers/{constant_handler.rb → ruby/legacy/constant_handler.rb} +2 -2
data/lib/yard/handlers/{exception_handler.rb → ruby/legacy/exception_handler.rb} +3 -3
data/lib/yard/handlers/ruby/legacy/extend_handler.rb +18 -0
data/lib/yard/handlers/ruby/legacy/method_handler.rb +31 -0
data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +28 -0
data/lib/yard/handlers/{module_handler.rb → ruby/legacy/module_handler.rb} +1 -1
data/lib/yard/handlers/{visibility_handler.rb → ruby/legacy/visibility_handler.rb} +1 -1
data/lib/yard/handlers/{yield_handler.rb → ruby/legacy/yield_handler.rb} +4 -4
data/lib/yard/handlers/ruby/method_condition_handler.rb +7 -0
data/lib/yard/handlers/ruby/method_handler.rb +48 -0
data/lib/yard/handlers/ruby/mixin_handler.rb +25 -0
data/lib/yard/handlers/ruby/module_handler.rb +9 -0
data/lib/yard/handlers/ruby/visibility_handler.rb +18 -0
data/lib/yard/handlers/ruby/yield_handler.rb +28 -0
data/lib/yard/parser/ruby/ast_node.rb +263 -0
data/lib/yard/parser/{ruby_lex.rb → ruby/legacy/ruby_lex.rb} +258 -259
data/lib/yard/parser/{statement.rb → ruby/legacy/statement.rb} +8 -4
data/lib/yard/parser/ruby/legacy/statement_list.rb +262 -0
data/lib/yard/parser/{token_list.rb → ruby/legacy/token_list.rb} +1 -1
data/lib/yard/parser/ruby/ruby_parser.rb +307 -0
data/lib/yard/parser/source_parser.rb +76 -45
data/lib/yard/rake/yardoc_task.rb +6 -1
data/lib/yard/registry.rb +45 -19
data/lib/yard/serializers/file_system_serializer.rb +8 -3
data/lib/yard/tags/default_factory.rb +70 -10
data/lib/yard/tags/default_tag.rb +12 -0
data/lib/yard/tags/library.rb +65 -26
data/lib/yard/tags/option_tag.rb +12 -0
data/lib/yard/tags/overload_tag.rb +62 -0
data/lib/yard/tags/ref_tag.rb +7 -0
data/lib/yard/tags/ref_tag_list.rb +27 -0
data/lib/yard/tags/tag.rb +1 -0
data/lib/yard/tags/tag_format_error.rb +6 -0
data/spec/cli/yardoc_spec.rb +43 -0
data/spec/code_objects/base_spec.rb +56 -68
data/spec/code_objects/class_object_spec.rb +18 -6
data/spec/code_objects/constants_spec.rb +2 -0
data/spec/code_objects/method_object_spec.rb +33 -5
data/spec/code_objects/module_object_spec.rb +66 -8
data/spec/code_objects/namespace_object_spec.rb +37 -17
data/spec/code_objects/proxy_spec.rb +13 -2
data/spec/core_ext/string_spec.rb +14 -2
data/spec/core_ext/symbol_hash_spec.rb +9 -3
data/spec/docstring_spec.rb +139 -0
data/spec/generators/full_doc_generator_spec.rb +29 -0
data/spec/generators/helpers/html_helper_spec.rb +74 -0
data/spec/generators/helpers/markup_helper_spec.rb +95 -0
data/spec/handlers/alias_handler_spec.rb +16 -3
data/spec/handlers/attribute_handler_spec.rb +1 -1
data/spec/handlers/base_spec.rb +15 -141
data/spec/handlers/class_condition_handler_spec.rb +49 -0
data/spec/handlers/class_handler_spec.rb +44 -3
data/spec/handlers/class_variable_handler_spec.rb +1 -1
data/spec/handlers/constant_handler_spec.rb +1 -1
data/spec/handlers/examples/alias_handler_001.rb.txt +7 -3
data/spec/handlers/examples/class_condition_handler_001.rb.txt +61 -0
data/spec/handlers/examples/class_handler_001.rb.txt +33 -0
data/spec/handlers/examples/exception_handler_001.rb.txt +1 -1
data/spec/handlers/examples/extend_handler_001.rb.txt +8 -0
data/spec/handlers/examples/method_condition_handler_001.rb.txt +10 -0
data/spec/handlers/examples/method_handler_001.rb.txt +16 -4
data/spec/handlers/examples/mixin_handler_001.rb.txt +10 -2
data/spec/handlers/examples/module_handler_001.rb.txt +4 -0
data/spec/handlers/examples/visibility_handler_001.rb.txt +1 -1
data/spec/handlers/exception_handler_spec.rb +2 -2
data/spec/handlers/extend_handler_spec.rb +15 -0
data/spec/handlers/legacy_base_spec.rb +128 -0
data/spec/handlers/method_condition_handler_spec.rb +14 -0
data/spec/handlers/method_handler_spec.rb +38 -5
data/spec/handlers/mixin_handler_spec.rb +15 -7
data/spec/handlers/module_handler_spec.rb +5 -1
data/spec/handlers/processor_spec.rb +19 -0
data/spec/handlers/ruby/base_spec.rb +90 -0
data/spec/handlers/ruby/legacy/base_spec.rb +53 -0
data/spec/handlers/spec_helper.rb +22 -16
data/spec/handlers/visibility_handler_spec.rb +4 -4
data/spec/handlers/yield_handler_spec.rb +1 -1
data/spec/parser/ruby/ast_node_spec.rb +15 -0
data/spec/parser/ruby/legacy/statement_list_spec.rb +145 -0
data/spec/parser/{token_list_spec.rb → ruby/legacy/token_list_spec.rb} +4 -4
data/spec/parser/source_parser_spec.rb +0 -15
data/spec/rake/yardoc_task_spec.rb +48 -0
data/spec/registry_spec.rb +28 -2
data/spec/serializers/file_system_serializer_spec.rb +7 -1
data/spec/spec_helper.rb +1 -1
data/spec/tags/default_factory_spec.rb +135 -0
data/spec/tags/default_tag_spec.rb +11 -0
data/spec/tags/overload_tag_spec.rb +35 -0
data/spec/tags/ref_tag_list_spec.rb +53 -0
data/templates/default/attributes/html/header.erb +17 -5
data/templates/default/attributes/text/header.erb +1 -1
data/templates/default/fulldoc/html/all_files.erb +19 -0
data/templates/default/fulldoc/html/all_methods.erb +8 -7
data/templates/default/fulldoc/html/all_namespaces.erb +4 -1
data/templates/default/fulldoc/html/app.js +1 -1
data/templates/default/fulldoc/html/{readme.erb → file.erb} +2 -2
data/templates/default/fulldoc/html/header.erb +1 -1
data/templates/default/fulldoc/html/index.erb +4 -3
data/templates/default/fulldoc/html/style.css +13 -3
data/templates/default/fulldoc/html/syntax_highlight.css +8 -5
data/templates/default/method/text/header.erb +1 -0
data/templates/default/method/text/title.erb +1 -0
data/templates/default/methodsignature/html/main.erb +10 -8
data/templates/default/methodsignature/text/main.erb +4 -1
data/templates/default/methodsummary/html/summary.erb +8 -4
data/templates/default/methodsummary/text/summary.erb +4 -1
data/templates/default/mixins/html/header.erb +3 -3
data/templates/default/overloads/html/header.erb +8 -0
data/templates/default/overloads/text/header.erb +8 -0
data/templates/default/root/html/header.erb +4 -0
data/templates/default/tags/html/example.erb +20 -0
data/templates/default/tags/html/option.erb +27 -0
data/templates/default/tags/html/param.erb +21 -0
data/templates/default/tags/html/tags.erb +4 -1
data/templates/default/tags/html/todo.erb +8 -0
data/templates/default/tags/text/example.erb +14 -0
data/templates/default/tags/text/header.erb +3 -3
data/templates/default/tags/text/option.erb +5 -0
data/templates/default/tags/text/param.erb +9 -0
data/templates/default/uml/dot/dependencies.erb +1 -1
data/templates/default/uml/dot/info.erb +1 -1
data/templates/default/uml/dot/superclasses.erb +2 -2
data/templates/javadoc/methodsummary/html/summary.erb +2 -2
data/templates/javadoc/mixins/html/header.erb +3 -3
metadata +108 -139
data/README +0 -211
data/lib/yard/handlers/method_handler.rb +0 -27
data/lib/yard/handlers/mixin_handler.rb +0 -16
data/lib/yard/parser/statement_list.rb +0 -167
data/lib/yard/tags/merbdoc_factory.rb +0 -47

data/templates/default/fulldoc/html/all_files.erb ADDED Viewed

@@ -0,0 +1,19 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+  <head>
+    <%= render :html_head %>
+    <title>All Files</title>
+    <base target="main" />
+  </head>
+  <body>
+    <div id="nav" class="files">
+      <h1>Files List</h1>
+      <ul>
+      <% for file in extra_files %>
+        <li nowrap><a href="<%= File.basename(file) %>.html"><%= File.basename(file) %></a></li>
+      <% end %>
+      </ul>
+    </div>
+  </body>
+</html>

data/templates/default/fulldoc/html/all_methods.erb CHANGED Viewed

@@ -3,18 +3,19 @@
 <html>
   <head>
     <%= render :html_head %>
-    <title>All Modules / Classes</title>
+    <title>All Methods</title>
     <base target="main" />
   </head>
   <body>
     <div id="nav" class="methods">
       <h1>Method List</h1>
       <ul>
-      <% for obj in YARD::Registry.all(:method).sort_by {|o| o.path } %>
-        <% next if obj.namespace == Registry.root %>
-        <li nowrap>
-          <%= linkify(obj, (obj.scope == :class ? '' : '#') + obj.name.to_s) %>
-          <% if obj.namespace != Registry.root %>
+      <% for obj in objects %>
+        <li nowrap="nowrap">
+          <%= linkify(obj, (obj.scope == :class ? '' : '#') + obj.name.to_s, nil, false) %>
+          <% if obj.namespace == Registry.root %>
+            <em>(Global method)</em>
+          <% else %>
             <em>(<%= obj.namespace.type %> <%= obj.namespace.name %>)</em>
           <% end %>
         </li>
@@ -22,4 +23,4 @@
       </ul>
     </div>
   </body>
-</html>
+</html>

data/templates/default/fulldoc/html/all_namespaces.erb CHANGED Viewed

@@ -10,7 +10,10 @@
     <div id="nav" class="namespaces">
       <h1>All Modules / Classes</h1>
       <ul>
-      <% for obj in YARD::Registry.all(:module, :class).sort_by {|o| o.path } %>
+      <% if root %>
+        <li><%= linkify(root, "Top Level Namespace", nil, false) %></li>
+      <% end %>
+      <% for obj in objects %>
         <li><%= linkify(obj) %> <em>(<%= obj.type %>)</em></li>
       <% end %>
       </ul>

data/templates/default/fulldoc/html/app.js CHANGED Viewed

@@ -5,7 +5,7 @@ $(document).ready(function() {
     }
     // Setup the view source links
-    $(".section.source a.source_link").toggle(
+    $("a.source_link").toggle(
         function() {
             $(this).text('Hide source');
             $(this).parent().next().show();

data/templates/default/fulldoc/html/{readme.erb → file.erb} RENAMED Viewed

@@ -3,12 +3,12 @@
 <html>
   <head>
     <%= render :html_head %>
-    <title>README</title>
+    <title><%= filename %></title>
   </head>
   <body>
     <div id="content">
       <div class="section docstring readme">
-        <%= htmlify @contents %>
+        <%= htmlify @contents, markup_for(filename) %>
       </div>
     </div>
   </body>

data/templates/default/fulldoc/html/header.erb CHANGED Viewed

@@ -5,7 +5,7 @@
     <%= render :html_head %>
     <script src="<%= url_for(js_file) %>" type="text/javascript" charset="utf-8"></script>
     <script src="<%= url_for(js_app_file) %>" type="text/javascript" charset="utf-8"></script>
-    <title><%= h format_object_type(object) %>: <%= h object.path %></title>
+    <title><%= h format_object_title(object) %></title>
   </head>
   <body>
     <div id="content">

data/templates/default/fulldoc/html/index.erb CHANGED Viewed

@@ -6,13 +6,14 @@
     <title>YARD Documentation</title>
   </head>
   <frameset cols="20%,*">
-    <frameset rows="50%,50%">
+    <frameset rows="13%,45%,42%">
+      <frame src="all-files.html" />
       <frame src="all-namespaces.html" />
       <frame src="all-methods.html" />
     </frameset>
-    <frame name="main" src="<%= readme_file ? 'readme.html' : url_for(Registry.all(:module, :class).sort_by {|o| o.path }.first) %>" />
+    <frame name="main" src="<%= extra_files.first ? File.basename(extra_files.first)+'.html' : url_for(Registry.all(:module, :class).sort_by {|o| o.path }.first) %>" />
     <noframes>
-      <p><a href="<%= readme_file ? 'readme.html' : url_for(Registry.all(:module, :class).sort_by {|o| o.path }.first) %>">Click here to go to the title page</a>.</p>
+      <p><a href="<%= extra_files.first ? File.basename(extra_files.first)+'.html' : url_for(Registry.all(:module, :class).sort_by {|o| o.path }.first) %>">Click here to go to the title page</a>.</p>
     </noframes>
   </frameset>
 </html>

data/templates/default/fulldoc/html/style.css CHANGED Viewed

@@ -14,21 +14,27 @@ h3 { font-size: 1.0em; }
 .methodsignature .visibility { display: none; }
 .methodsignature .name { font-weight: bold; }
 .methoddetails .method_header h3 { display: none; }
+.section h3 { margin-left: 20px; }
 .section.method { background: #eee; margin-bottom: 0.8em; }
+.overload .section.method { background: #f5f5f5; margin-left: 2em; margin-right: 2em; }
 .section.tags,.section.docstring,.section.source { padding: 5px 12px; }
 .section.method .details_title { font-size: 1.1em; background: #dde; padding: 7px; }
+.overload .section.method .details_title { background: #e2e2ea; }
 .section.method .details_title p.aliases { padding: 0; margin: 0; font-style: italic; font-size: 0.9em; }
 .section.method .details_title p.aliases tt { font-weight: bold; font-style: normal; font-size: 1.1em; }
 .section.constants dl { font-family: monospace; }
 .section.constants dt { font-weight: bold; font-size: 1.1em; }
 .section.constants dt:after { content: " = "; }
 .section.constants dd { margin-bottom: 1em; }
-.section.source .source_link { font-size: 0.9em; }
-.section.source .source_code { display: none; }
+.section .source_link { font-size: 0.9em; }
+.section .source_code { display: none; }
 /*.section.source .source_code pre { float: left; }*/
 .section.attributes table { padding: 0; width: 100%; }
 .section.attributes .readwrite { width: 5%; }
 .section.attributes .name { font-weight: bold; width: 10%; }
+.section.attributes .aliases { padding-top: 0; padding-left: 0; }
+.section.attributes .aliases .text { font-size: 0.8em; }
+.section.attributes .aliases .alias { font-family: monospace; font-weight: bold; }
 .section.attributes .visibility { font-style: italic; color: #666; width: 5%; }
 .section.attributes td, .section.attributes th { vertical-align: top; padding: 5px; }
 .section.attributes th { padding-left: 0; text-align: left; }
@@ -36,6 +42,7 @@ h3 { font-size: 1.0em; }
 .section.attributes .docstring .return_types { font-style: normal; }
 .section.attributes .docstring { width: 80%; }
 .section.attributes .docstring * { display: inline; }
+.section.attributes tr.hasaliases td, .section.attributes tr.hasaliases th { padding-bottom: 0; }
 .section.inheritance { background: #ddd; padding: 5px; border: 1px solid #ccc; border-top: 0; }
 .section.inheritance ul { list-style: none; padding-left: 2.2em; margin: 0; }
 .section.inheritance ul li { line-height: 1.2em; }
@@ -48,7 +55,7 @@ h3 { font-size: 1.0em; }
 .section.methodsummary th { background: #dde; text-align: left; white-space: nowrap; padding-right: 12px; }
 .section.methodsummary .signature { font-family: monospace; font-weight: normal; }
 .section.methodsummary .signature .name { font-weight: bold; }
-.section.methodsummary .signature .alias { display: block; }
+.section.methodsummary .signature .alias, .section.methodsummary .signature .overload { display: block; }
 .section.methodsummary .docstring { width: 80%; }
 .section.methodsummary .docstring * { display: inline; }
 .section.methodsummary .docstring p.returns { color: #555; font-style: italic; }
@@ -57,6 +64,9 @@ h3 { font-size: 1.0em; }
 .section.tags h2 { display: none; }
 .section.tags h3 { font-size: 1.0em; margin-top: 3px; }
 .section.tags dl { margin-left: 2em; }
+.section.tags .option table { width: 100%; border: 0; padding: 0; }
+.section.tags .option th { text-align: left; background: #e5e5e5; padding: 3px; }
+.section.tags .option td.name { font-family: monospace; }
 .section.methodmissing p.note { font-style: italic; }
 .section.constructor p.inherited_msg { font-style: italic; }
 .included h1, .inherited h1 { font-size: 1em !important; border: 0; margin: 0; padding: 5px; border-bottom: 1px solid #ccc; }

data/templates/default/fulldoc/html/syntax_highlight.css CHANGED Viewed

@@ -1,21 +1,24 @@
 /* Canvas */
-.docstring pre, .source_code { background: #222; padding: 0 12px; margin-top: 8px; border: 1px dashed #ccc; font-size: 0.9em; overflow-x: auto; }
 .source_code pre.lines { margin-right: 20px; text-align: right; color: #888; }
 .docstring pre { padding: 12px; padding-left: 0; }
+.docstring pre, .source_code { background: #222; padding: 12px; margin-top: 8px; border: 1px dashed #ccc; font-size: 0.9em; overflow-x: auto; }
 /* Token colours. Borrowed from pastie.org's "Blackboard" theme */
 pre.code, pre.lines { font-family: Monaco, Courier, monospace; }
 pre.code { color: #fff; }
 pre.code .info.file { color: #888; }
-pre.code .val { color: #61CE3C; }
-pre.code .dstring { color: #61DE3C; }
+pre.code .val, pre.code .int, pre.code .float { color: #61CE3C; }
+pre.code .dstring, pre.code .tstring_content,
+pre.code .regexp_beg, pre.code .regexp_end,
+pre.code .tstring_beg, pre.code .tstring_end { color: #61DE3C; }
+pre.code .embexpr_beg, pre.code .tstring, pre.code .tstring .rbrace { color: #7CFE65; }
 pre.code .fid, pre.code .id.new, pre.code .id.to_s,
 pre.code .id.to_sym, pre.code .id.to_f,
 pre.code .dot + pre.code .id,
 pre.code .id.to_i pre.code .id.each { color: #FF6400; }
 pre.code .comment { color: #AEAEAE; }
-pre.code .constant, pre.code .symbol { color: #D8FA3C; }
+pre.code .constant, pre.code .const, pre.code .symbol, pre.code .symbeg { color: #D8FA3C; }
 pre.code .kw { color: #FBDE2D; }
 pre.code .ivar { color: #AACEFB; }
-pre.code .gvar, pre.code .id.nth_ref { color: #BADEFF; }
+pre.code .gvar, pre.code .backref, pre.code .id.nth_ref { color: #BADEFF; }
 pre.code .regexp, .dregexp { color: #EA5EFB; }

data/templates/default/method/text/header.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= yield object %>

data/templates/default/method/text/title.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= yield object %>

data/templates/default/methodsignature/html/main.erb CHANGED Viewed

@@ -1,8 +1,10 @@
-<div class='section <%=generator_name %>'>
-  <tt class='def'>
-    <span class='visibility'><%= object.visibility %></span>
-    <span class='return_types'><%= format_return_types object %></span>
-    <span class='name'><%= object.name %></span><span class='args'><%= format_args object %></span>
-    <span class='block'><%= format_block object %></span>
-  </tt>
-</div>
+<% overloads(object).each do |overload| %>
+  <div class='section <%=generator_name %>'>
+    <tt class='def'>
+      <span class='visibility'><%= overload.visibility %></span>
+      <span class='return_types'><%= format_return_types overload %></span>
+      <span class='name'><%= overload.name %></span><span class='args'><%= format_args overload %></span>
+      <span class='block'><%= format_block overload %></span>
+    </tt>
+  </div>
+<% end %>

data/templates/default/methodsignature/text/main.erb CHANGED Viewed

@@ -1,5 +1,8 @@
 Method Signature
 ----------------
-<%= object.visibility %> <%= format_return_types object %> <%= object.name %><%= format_args object %> <%= format_block object %>
+<% overloads(object).each do |overload| %>
+<%= overload.visibility %> <%= format_return_types overload %> <%= overload.name %><%= format_args overload %> <%= format_block overload %>
+<% end %>

data/templates/default/methodsummary/html/summary.erb CHANGED Viewed

@@ -3,14 +3,18 @@
   <% method_list.each do |meth| %>
     <tr>
       <th class="signature">
-        <span class='name'><%= linkify(meth, meth.name(true)) %></span><span class='args'><%= format_args meth %></span>
-        <span class='block'><%= format_block meth %></span>
+        <% overloads(meth).each do |overload| %>
+          <span class='overload'>
+            <span class='name'><%= linkify(meth, overload.name(true)) %></span><span class='args'><%= format_args overload %></span>
+            <span class='block'><%= format_block overload %></span>
+          </span>
+        <% end %>
         <% meth.aliases.each do |obj| %>
           <span class='alias'><%= h obj.name(true) %></span>
         <% end %>
       </th>
       <td class="docstring">
-        <%= htmlify meth.short_docstring %>
+        <%= htmlify meth.docstring.summary %>
         <% if meth.tag(:return) && meth.tag(:return).types %>
           <p class='returns'>
             Returns:
@@ -22,4 +26,4 @@
       </td>
     </tr>
   <% end %>
-</table>
+</table>

data/templates/default/methodsummary/text/summary.erb CHANGED Viewed

@@ -1,3 +1,6 @@
-<% method_list.sort_by {|m| "#{m.scope}#{m.name}" }.each do |meth| %><%= meth.visibility == :class ? '+' : '-' %> <%= meth.name(true) %><%= format_args meth %> <%= format_block meth %>
+<% method_list.sort_by {|m| "#{m.scope}#{m.name}" }.each do |meth| %>
+<% overloads(meth).each do |overload| %>
+<%= overload.visibility == :class ? '+' : '-' %> <%= overload.name(true) %><%= format_args overload %> <%= format_block overload %>
 <% end %>
+<% end %>

data/templates/default/mixins/html/header.erb CHANGED Viewed

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

data/templates/default/overloads/html/header.erb ADDED Viewed

@@ -0,0 +1,8 @@
+<div class="section <%= generator_name %>">
+  <h2>Overloads</h2>
+  <% overloads(object).each do |overload| %>
+    <div class="overload">
+      <%= yield overload %>
+    </div>
+  <% end %>
+</div>

data/templates/default/overloads/text/header.erb ADDED Viewed

@@ -0,0 +1,8 @@
+Overloads
+=========
+<% overloads(object).each do |overload| %>
+<%= yield(overload).gsub(/^/, '  ') %>
+<% end %>

data/templates/default/root/html/header.erb ADDED Viewed

@@ -0,0 +1,4 @@
+<div class="section root">
+  <h1 class="title">Top Level Namespace (Global Methods)</h1>
+  <%= yield object %>
+</div>

data/templates/default/tags/html/example.erb ADDED Viewed

@@ -0,0 +1,20 @@
+<% if object.has_tag?(:example) %>
+<div class="examples">
+  <% if object.tags(:example).size == 1 %>
+    <h3>Example: <small><%= object.tag(:example).name %></small></h3>
+    <div class="docstring">
+      <pre class="code"><%= html_syntax_highlight object.tag(:example).text %></pre>
+    </div>
+  <% else %>
+    <h3>Examples</h3>
+    <% object.tags(:example).each do |tag| %>
+    <dl>
+      <dt><%= tag.name %></dt>
+      <dd class="docstring">
+        <pre class="code"><%= html_syntax_highlight tag.text %></pre>
+      </dd>
+    </dl>
+    <% end %>
+  <% end %>
+</div>
+<% end %>

data/templates/default/tags/html/option.erb ADDED Viewed

@@ -0,0 +1,27 @@
+<dt>Options Hash <tt><%= param %></tt></dt>
+<dd>
+  <div class="option">
+    <table>
+      <tr>
+        <th class="name">Key Name</th>
+        <th class="default">Default Value</th>
+        <th class="type">Accepted Types</th>
+        <th class="desc">Description</th>
+      </tr>
+      <% for tag in object.tags(:option).select {|x| x.name.to_s == param } %>
+        <tr>
+          <td class="name"><%= tag.pair.name %></td>
+          <td class="default">
+            <% if tag.pair.defaults %>
+              <%= tag.pair.defaults.map {|t| "<tt>#{h t}</tt>" }.join(", ") %>
+            <% else %>
+              <span class="na">N/A</span>
+            <% end %>
+          </td>
+          <td class="type"><%= format_types (tag.pair.types || ['Object']) %></td>
+          <td class="desc"><%= htmlify tag.pair.text %></td>
+        </tr>
+      <% end %>
+    </table>
+  </div>
+</dd>

data/templates/default/tags/html/param.erb ADDED Viewed

@@ -0,0 +1,21 @@
+<div class="param">
+  <h3><%= YARD::Tags::Library.labels[:param] %>:</h3>
+  <dl>
+  <% for tag in tags_by_param(object) %>
+    <% if tag.is_a?(YARD::Tags::OptionTag) %>
+      <%= render object, 'option', :param => tag.name.to_s %>
+    <% else %>
+      <dt>
+        <span class='type'><%= format_types (tag.types || ['Object']) %></span>
+        <span class='name'><%= h tag.name %></span>
+        <% if (o=object.parameters.assoc(tag.name.to_sym)) && o[1] %>
+          <em class="default">(defaults to: <tt><%= h o[1] %></tt>)</em>
+        <% end %>
+      </dt>
+      <dd>
+        <span class='desc'><%= htmlify tag.text if tag.text %></span>
+      </dd>
+    <% end %>
+  <% end %>
+  </dl>
+</div>

data/templates/default/tags/html/tags.erb CHANGED Viewed

@@ -5,11 +5,14 @@
   <% for tag in object.tags(name) %>
     <dt>
       <% unless defined?(no_types) %>
-        <span class='type'><%= format_types tag.types %></span>
+        <span class='type'><%= format_types (tag.types || ['Object']) %></span>
       <% end %>
       <% unless defined?(no_names) %>
         <span class='name'><%= h tag.name %></span>
       <% end %>
+      <% if name == :param && (o=object.parameters.assoc(tag.name.to_sym)) && o[1] %>
+        <em class="default">(defaults to: <tt><%= h o[1] %></tt>)</em>
+      <% end %>
     </dt>
     <dd>
       <span class='desc'><%= htmlify tag.text %></span>

data/templates/default/tags/html/todo.erb ADDED Viewed

@@ -0,0 +1,8 @@
+<div class="todo">
+  <h3><%= YARD::Tags::Library.labels[:todo] %>:</h3>
+  <ul>
+  <% for tag in object.tags(:todo) %>
+    <li><strong><%= tag.name %></strong> <%= tag.text %></li>
+  <% end %>
+  </ul>
+</div>

data/templates/default/tags/text/example.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<% if object.has_tag?(:example) %>
+<% if object.tags(:example).size == 1 %>
+> Example: <%= object.tag(:example).name %>
+<%= object.tag(:example).text.gsub(/^/, '  ') %>
+<% else %>
+> Examples:
+<% object.tags(:example).each do |tag| %>
+<%= "  [" + tag.name + "]" if tag.name %>
+<%= tag.text.gsub(/^/, '  ') %>
+<% end %>
+<% end %>
+<% end %>

data/templates/default/tags/text/header.erb CHANGED Viewed

@@ -1,3 +1,3 @@
-Meta Tags:
-----------
-<%= yield object %>
+<%= yield(object).strip %>