yard 0.2.3.5 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of yard might be problematic. Click here for more details.
- data/.yardopts +12 -10
- data/ChangeLog +5686 -0
- data/{README.markdown → README.md} +65 -11
- data/Rakefile +25 -13
- data/benchmarks/concat_vs_join.rb +12 -0
- data/benchmarks/erb_vs_erubis.rb +14 -14
- data/benchmarks/marshal_vs_dbm.rb +1 -1
- data/benchmarks/pathname_vs_string.rb +50 -0
- data/benchmarks/template_erb.rb +22 -0
- data/benchmarks/template_format.rb +6 -0
- data/benchmarks/template_profile.rb +17 -0
- data/bin/yri +16 -7
- data/docs/{CODE_OBJECTS.markdown → CodeObjects.md} +0 -0
- data/docs/{GETTING_STARTED.markdown → GettingStarted.md} +49 -11
- data/docs/{GLOSSARY.markdown → Glossary.md} +0 -0
- data/docs/{HANDLERS.markdown → Handlers.md} +5 -5
- data/docs/{OVERVIEW.markdown → Overview.md} +9 -13
- data/docs/{PARSER.markdown → Parser.md} +1 -1
- data/docs/{TAGS.markdown → Tags.md} +1 -1
- data/docs/Templates.md +286 -0
- data/docs/{WHATSNEW.markdown → WhatsNew.md} +82 -2
- data/lib/rubygems_plugin.rb +17 -20
- data/lib/yard.rb +47 -1
- data/lib/yard/autoload.rb +38 -47
- data/lib/yard/cli/yard_graph.rb +36 -13
- data/lib/yard/cli/yardoc.rb +74 -12
- data/lib/yard/code_objects/base.rb +182 -14
- data/lib/yard/code_objects/class_object.rb +39 -2
- data/lib/yard/code_objects/class_variable_object.rb +4 -0
- data/lib/yard/code_objects/constant_object.rb +8 -0
- data/lib/yard/code_objects/extended_method_object.rb +14 -0
- data/lib/yard/code_objects/method_object.rb +60 -2
- data/lib/yard/code_objects/module_object.rb +6 -0
- data/lib/yard/code_objects/namespace_object.rb +99 -2
- data/lib/yard/code_objects/proxy.rb +53 -6
- data/lib/yard/code_objects/root_object.rb +2 -0
- data/lib/yard/core_ext/array.rb +61 -0
- data/lib/yard/core_ext/file.rb +21 -4
- data/lib/yard/core_ext/module.rb +11 -1
- data/lib/yard/core_ext/string.rb +13 -2
- data/lib/yard/core_ext/symbol_hash.rb +51 -3
- data/lib/yard/docstring.rb +68 -19
- data/lib/yard/globals.rb +5 -2
- data/lib/yard/handlers/base.rb +13 -3
- data/lib/yard/handlers/processor.rb +64 -2
- data/lib/yard/handlers/ruby/class_handler.rb +1 -1
- data/lib/yard/handlers/ruby/class_variable_handler.rb +5 -1
- data/lib/yard/handlers/ruby/constant_handler.rb +38 -4
- data/lib/yard/handlers/ruby/exception_handler.rb +1 -0
- data/lib/yard/handlers/ruby/legacy/base.rb +2 -2
- data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +6 -3
- data/lib/yard/handlers/ruby/legacy/constant_handler.rb +21 -2
- data/lib/yard/handlers/ruby/legacy/method_handler.rb +10 -0
- data/lib/yard/handlers/ruby/legacy/yield_handler.rb +2 -1
- data/lib/yard/handlers/ruby/method_handler.rb +10 -0
- data/lib/yard/handlers/ruby/yield_handler.rb +2 -1
- data/lib/yard/logging.rb +17 -0
- data/lib/yard/parser/ruby/ast_node.rb +101 -0
- data/lib/yard/parser/ruby/legacy/ruby_lex.rb +2 -2
- data/lib/yard/parser/ruby/legacy/statement_list.rb +10 -9
- data/lib/yard/parser/ruby/ruby_parser.rb +32 -3
- data/lib/yard/parser/source_parser.rb +82 -5
- data/lib/yard/rake/yardoc_task.rb +38 -3
- data/lib/yard/registry.rb +112 -2
- data/lib/yard/serializers/base.rb +48 -1
- data/lib/yard/serializers/file_system_serializer.rb +23 -2
- data/lib/yard/serializers/process_serializer.rb +10 -0
- data/lib/yard/serializers/stdout_serializer.rb +11 -0
- data/lib/yard/tags/library.rb +4 -1
- data/lib/yard/tags/overload_tag.rb +3 -12
- data/lib/yard/templates/engine.rb +162 -0
- data/lib/yard/{generators → templates}/helpers/base_helper.rb +14 -13
- data/lib/yard/{generators → templates}/helpers/filter_helper.rb +1 -1
- data/lib/yard/templates/helpers/html_helper.rb +287 -0
- data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +29 -0
- data/lib/yard/templates/helpers/html_syntax_highlight_helper18.rb +27 -0
- data/lib/yard/{generators → templates}/helpers/markup_helper.rb +15 -11
- data/lib/yard/{generators → templates}/helpers/method_helper.rb +8 -1
- data/lib/yard/templates/helpers/module_helper.rb +15 -0
- data/lib/yard/templates/helpers/text_helper.rb +60 -0
- data/lib/yard/templates/helpers/uml_helper.rb +33 -0
- data/lib/yard/templates/template.rb +355 -0
- data/lib/yard/verifier.rb +110 -0
- data/spec/cli/yardoc_spec.rb +23 -1
- data/spec/code_objects/base_spec.rb +8 -0
- data/spec/code_objects/class_object_spec.rb +166 -156
- data/spec/code_objects/method_object_spec.rb +2 -2
- data/spec/code_objects/module_object_spec.rb +112 -110
- data/spec/code_objects/proxy_spec.rb +9 -0
- data/spec/core_ext/array_spec.rb +33 -0
- data/spec/core_ext/file_spec.rb +40 -12
- data/spec/core_ext/module_spec.rb +15 -0
- data/spec/core_ext/string_spec.rb +10 -2
- data/spec/docstring_spec.rb +157 -135
- data/spec/handlers/class_handler_spec.rb +3 -0
- data/spec/handlers/class_variable_handler_spec.rb +3 -1
- data/spec/handlers/constant_handler_spec.rb +38 -0
- data/spec/handlers/examples/class_handler_001.rb.txt +14 -1
- data/spec/handlers/examples/class_variable_handler_001.rb.txt +1 -0
- data/spec/handlers/examples/constant_handler_001.rb.txt +10 -1
- data/spec/handlers/examples/exception_handler_001.rb.txt +5 -0
- data/spec/handlers/examples/method_handler_001.rb.txt +15 -0
- data/spec/handlers/examples/mixin_handler_001.rb.txt +13 -0
- data/spec/handlers/exception_handler_spec.rb +4 -0
- data/spec/handlers/method_handler_spec.rb +22 -0
- data/spec/handlers/mixin_handler_spec.rb +5 -3
- data/spec/handlers/yield_handler_spec.rb +1 -1
- data/spec/parser/ruby/ast_node_spec.rb +16 -0
- data/spec/parser/ruby/legacy/statement_list_spec.rb +36 -0
- data/spec/parser/ruby/ruby_parser_spec.rb +80 -0
- data/spec/parser/source_parser_spec.rb +48 -2
- data/spec/rake/yardoc_task_spec.rb +62 -25
- data/spec/serializers/file_system_serializer_spec.rb +1 -1
- data/spec/templates/class_spec.rb +34 -0
- data/spec/templates/engine_spec.rb +121 -0
- data/spec/templates/examples/class001.html +271 -0
- data/spec/templates/examples/class001.txt +31 -0
- data/spec/templates/examples/method001.html +96 -0
- data/spec/templates/examples/method001.txt +28 -0
- data/spec/templates/examples/method002.html +81 -0
- data/spec/templates/examples/method002.txt +20 -0
- data/spec/templates/examples/method003.html +137 -0
- data/spec/templates/examples/method003.txt +45 -0
- data/spec/templates/examples/module001.dot +31 -0
- data/spec/templates/examples/module001.html +294 -0
- data/spec/templates/examples/module001.txt +33 -0
- data/spec/templates/examples/tag001.txt +82 -0
- data/spec/templates/helpers/base_helper_spec.rb +129 -0
- data/spec/{generators → templates}/helpers/html_helper_spec.rb +73 -16
- data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +39 -0
- data/spec/{generators → templates}/helpers/markup_helper_spec.rb +6 -7
- data/spec/templates/method_spec.rb +75 -0
- data/spec/templates/module_spec.rb +50 -0
- data/spec/templates/spec_helper.rb +33 -0
- data/spec/templates/tag_spec.rb +39 -0
- data/spec/templates/template_spec.rb +398 -0
- data/spec/verifier_spec.rb +51 -0
- data/spec/yard_spec.rb +46 -0
- data/templates/default/class/dot/setup.rb +6 -0
- data/templates/default/class/dot/superklass.erb +3 -0
- data/templates/default/class/html/constructor_details.erb +8 -0
- data/templates/default/class/html/setup.rb +1 -0
- data/templates/default/class/html/subclasses.erb +4 -0
- data/templates/default/class/setup.rb +29 -0
- data/templates/default/class/text/setup.rb +11 -0
- data/templates/default/class/text/subclasses.erb +5 -0
- data/templates/default/docstring/html/abstract.erb +4 -0
- data/templates/default/docstring/html/deprecated.erb +1 -0
- data/templates/default/docstring/html/index.erb +5 -0
- data/templates/default/docstring/html/note.erb +6 -0
- data/templates/default/docstring/html/text.erb +1 -0
- data/templates/default/docstring/html/todo.erb +6 -0
- data/templates/default/docstring/setup.rb +39 -0
- data/templates/default/docstring/text/abstract.erb +2 -0
- data/templates/default/docstring/text/deprecated.erb +2 -0
- data/templates/default/docstring/text/index.erb +2 -0
- data/templates/default/docstring/text/note.erb +4 -0
- data/templates/default/docstring/text/text.erb +1 -0
- data/templates/default/docstring/text/todo.erb +4 -0
- data/templates/default/fulldoc/html/css/common.css +1 -0
- data/templates/default/fulldoc/html/css/full_list.css +23 -0
- data/templates/default/fulldoc/html/css/style.css +261 -0
- data/templates/default/fulldoc/html/full_list.erb +36 -0
- data/templates/default/fulldoc/html/js/app.js +91 -0
- data/templates/default/fulldoc/html/js/full_list.js +39 -0
- data/templates/default/fulldoc/html/js/jquery.js +19 -0
- data/templates/default/fulldoc/html/setup.rb +86 -0
- data/templates/default/{uml → layout}/dot/header.erb +2 -2
- data/templates/default/layout/dot/setup.rb +14 -0
- data/templates/default/layout/html/breadcrumb.erb +11 -0
- data/templates/default/layout/html/footer.erb +5 -0
- data/templates/default/layout/html/headers.erb +13 -0
- data/templates/default/layout/html/index.erb +49 -0
- data/templates/default/layout/html/layout.erb +20 -0
- data/templates/default/layout/html/search.erb +5 -0
- data/templates/default/layout/html/setup.rb +58 -0
- data/templates/default/method/html/header.erb +14 -3
- data/templates/default/method/setup.rb +3 -0
- data/templates/default/method/text/header.erb +1 -1
- data/templates/default/method_details/html/header.erb +3 -0
- data/templates/default/method_details/html/method_signature.erb +17 -0
- data/templates/default/method_details/html/source.erb +10 -0
- data/templates/default/method_details/setup.rb +8 -0
- data/templates/default/method_details/text/header.erb +10 -0
- data/templates/default/method_details/text/method_signature.erb +12 -0
- data/templates/default/method_details/text/setup.rb +10 -0
- data/templates/default/module/dot/child.erb +1 -0
- data/templates/default/module/dot/dependencies.erb +3 -0
- data/templates/default/{uml/dot/subgraph.erb → module/dot/header.erb} +3 -3
- data/templates/default/{uml → module}/dot/info.erb +4 -4
- data/templates/default/module/dot/setup.rb +14 -0
- data/templates/default/module/html/attribute_details.erb +11 -0
- data/templates/default/module/html/attribute_summary.erb +8 -0
- data/templates/default/module/html/box_info.erb +32 -0
- data/templates/default/module/html/children.erb +8 -0
- data/templates/default/module/html/constant_summary.erb +13 -0
- data/templates/default/module/html/defines.erb +3 -0
- data/templates/default/module/html/header.erb +4 -4
- data/templates/default/module/html/inherited_constants.erb +8 -0
- data/templates/default/module/html/inherited_methods.erb +9 -0
- data/templates/default/module/html/item_summary.erb +20 -0
- data/templates/default/module/html/method_details_list.erb +8 -0
- data/templates/default/module/html/method_summary.erb +8 -0
- data/templates/default/module/html/methodmissing.erb +12 -0
- data/templates/default/module/html/pre_docstring.erb +1 -0
- data/templates/default/module/setup.rb +83 -0
- data/templates/default/module/text/children.erb +10 -0
- data/templates/default/module/text/class_meths_list.erb +8 -0
- data/templates/default/module/text/extends.erb +8 -0
- data/templates/default/module/text/header.erb +7 -0
- data/templates/default/module/text/includes.erb +8 -0
- data/templates/default/module/text/instance_meths_list.erb +8 -0
- data/templates/default/module/text/setup.rb +12 -0
- data/templates/default/root/dot/child.erb +3 -0
- data/templates/default/root/dot/setup.rb +5 -0
- data/templates/default/tags/html/example.erb +5 -16
- data/templates/default/tags/html/index.erb +3 -0
- data/templates/default/tags/html/option.erb +17 -20
- data/templates/default/tags/html/overload.erb +13 -0
- data/templates/default/tags/html/see.erb +5 -10
- data/templates/default/tags/html/tag.erb +20 -0
- data/templates/default/tags/setup.rb +50 -0
- data/templates/default/tags/text/example.erb +8 -10
- data/templates/default/tags/text/index.erb +1 -0
- data/templates/default/tags/text/option.erb +18 -3
- data/templates/default/tags/text/overload.erb +19 -0
- data/templates/default/tags/text/see.erb +8 -2
- data/templates/default/tags/text/tag.erb +13 -0
- metadata +142 -158
- data/bin/view_generator +0 -17
- data/docs/FAQ.markdown +0 -34
- data/docs/GENERATORS.markdown +0 -211
- data/lib/yard/generators/attributes_generator.rb +0 -22
- data/lib/yard/generators/base.rb +0 -305
- data/lib/yard/generators/class_generator.rb +0 -27
- data/lib/yard/generators/constants_generator.rb +0 -74
- data/lib/yard/generators/constructor_generator.rb +0 -25
- data/lib/yard/generators/deprecated_generator.rb +0 -15
- data/lib/yard/generators/docstring_generator.rb +0 -15
- data/lib/yard/generators/full_doc_generator.rb +0 -127
- data/lib/yard/generators/helpers/html_helper.rb +0 -196
- data/lib/yard/generators/helpers/html_syntax_highlight_helper.rb +0 -49
- data/lib/yard/generators/helpers/uml_helper.rb +0 -16
- data/lib/yard/generators/inheritance_generator.rb +0 -16
- data/lib/yard/generators/method_details_generator.rb +0 -18
- data/lib/yard/generators/method_generator.rb +0 -43
- data/lib/yard/generators/method_listing_generator.rb +0 -105
- data/lib/yard/generators/method_missing_generator.rb +0 -25
- data/lib/yard/generators/method_signature_generator.rb +0 -19
- data/lib/yard/generators/method_summary_generator.rb +0 -21
- data/lib/yard/generators/mixins_generator.rb +0 -21
- data/lib/yard/generators/module_generator.rb +0 -23
- data/lib/yard/generators/overloads_generator.rb +0 -20
- data/lib/yard/generators/quick_doc_generator.rb +0 -25
- data/lib/yard/generators/root_generator.rb +0 -32
- data/lib/yard/generators/source_generator.rb +0 -11
- data/lib/yard/generators/tags_generator.rb +0 -99
- data/lib/yard/generators/uml_generator.rb +0 -102
- data/lib/yard/generators/visibility_group_generator.rb +0 -26
- data/spec/generators/base_spec.rb +0 -64
- data/spec/generators/full_doc_generator_spec.rb +0 -29
- data/spec/generators/helpers/base_helper_spec.rb +0 -15
- data/spec/generators/quick_doc_generator_spec.rb +0 -13
- data/templates/default/attributes/html/header.erb +0 -47
- data/templates/default/attributes/text/header.erb +0 -10
- data/templates/default/class/html/header.erb +0 -4
- data/templates/default/constants/html/constants.erb +0 -9
- data/templates/default/constants/html/header.erb +0 -3
- data/templates/default/constants/html/included.erb +0 -9
- data/templates/default/constants/html/inherited.erb +0 -9
- data/templates/default/constructor/html/header.erb +0 -10
- data/templates/default/deprecated/html/main.erb +0 -6
- data/templates/default/deprecated/text/main.erb +0 -3
- data/templates/default/docstring/html/main.erb +0 -3
- data/templates/default/docstring/text/main.erb +0 -3
- data/templates/default/fulldoc/html/all_files.erb +0 -19
- data/templates/default/fulldoc/html/all_methods.erb +0 -26
- data/templates/default/fulldoc/html/all_namespaces.erb +0 -22
- data/templates/default/fulldoc/html/app.js +0 -18
- data/templates/default/fulldoc/html/custom.css +0 -1
- data/templates/default/fulldoc/html/file.erb +0 -16
- data/templates/default/fulldoc/html/footer.erb +0 -5
- data/templates/default/fulldoc/html/header.erb +0 -16
- data/templates/default/fulldoc/html/html_head.erb +0 -4
- data/templates/default/fulldoc/html/index.erb +0 -19
- data/templates/default/fulldoc/html/jquery.js +0 -11
- data/templates/default/fulldoc/html/style.css +0 -81
- data/templates/default/fulldoc/html/syntax_highlight.css +0 -24
- data/templates/default/inheritance/html/header.erb +0 -8
- data/templates/default/inheritance/text/header.erb +0 -3
- data/templates/default/method/html/aliases.erb +0 -6
- data/templates/default/method/html/title.erb +0 -3
- data/templates/default/method/text/title.erb +0 -1
- data/templates/default/methoddetails/html/header.erb +0 -8
- data/templates/default/methoddetails/html/method_header.erb +0 -3
- data/templates/default/methodmissing/html/header.erb +0 -12
- data/templates/default/methodsignature/html/main.erb +0 -10
- data/templates/default/methodsignature/text/main.erb +0 -8
- data/templates/default/methodsummary/html/header.erb +0 -5
- data/templates/default/methodsummary/html/included.erb +0 -9
- data/templates/default/methodsummary/html/inherited.erb +0 -9
- data/templates/default/methodsummary/html/summary.erb +0 -29
- data/templates/default/methodsummary/text/header.erb +0 -5
- data/templates/default/methodsummary/text/included.erb +0 -0
- data/templates/default/methodsummary/text/inherited.erb +0 -0
- data/templates/default/methodsummary/text/summary.erb +0 -6
- data/templates/default/mixins/html/header.erb +0 -4
- data/templates/default/overloads/html/header.erb +0 -8
- data/templates/default/overloads/text/header.erb +0 -8
- data/templates/default/quickdoc/html/header.erb +0 -15
- data/templates/default/quickdoc/text/header.erb +0 -12
- data/templates/default/root/html/header.erb +0 -4
- data/templates/default/source/html/main.erb +0 -15
- data/templates/default/source/text/main.erb +0 -4
- data/templates/default/tags/html/header.erb +0 -4
- data/templates/default/tags/html/param.erb +0 -21
- data/templates/default/tags/html/tags.erb +0 -23
- data/templates/default/tags/html/todo.erb +0 -8
- data/templates/default/tags/text/header.erb +0 -3
- data/templates/default/tags/text/param.erb +0 -9
- data/templates/default/tags/text/tags.erb +0 -7
- data/templates/default/uml/dot/child.erb +0 -1
- data/templates/default/uml/dot/dependencies.erb +0 -10
- data/templates/default/uml/dot/superclasses.erb +0 -9
- data/templates/default/uml/dot/unknown.erb +0 -3
- data/templates/default/uml/dot/unknown_child.erb +0 -1
- data/templates/default/visibilitygroup/html/header.erb +0 -6
- data/templates/javadoc/attributes/html/header.erb +0 -16
- data/templates/javadoc/class/html/header.erb +0 -4
- data/templates/javadoc/constants/html/constants.erb +0 -9
- data/templates/javadoc/constants/html/header.erb +0 -3
- data/templates/javadoc/constants/html/included.erb +0 -12
- data/templates/javadoc/constants/html/inherited.erb +0 -12
- data/templates/javadoc/constructor/html/header.erb +0 -10
- data/templates/javadoc/deprecated/html/main.erb +0 -0
- data/templates/javadoc/docstring/html/main.erb +0 -6
- data/templates/javadoc/fulldoc/html/all_methods.erb +0 -25
- data/templates/javadoc/fulldoc/html/all_namespaces.erb +0 -19
- data/templates/javadoc/fulldoc/html/app.js +0 -18
- data/templates/javadoc/fulldoc/html/header.erb +0 -15
- data/templates/javadoc/fulldoc/html/html_head.erb +0 -3
- data/templates/javadoc/fulldoc/html/index.erb +0 -18
- data/templates/javadoc/fulldoc/html/jquery.js +0 -11
- data/templates/javadoc/fulldoc/html/readme.erb +0 -15
- data/templates/javadoc/fulldoc/html/style.css +0 -22
- data/templates/javadoc/fulldoc/html/syntax_highlight.css +0 -21
- data/templates/javadoc/inheritance/html/header.erb +0 -6
- data/templates/javadoc/method/html/aliases.erb +0 -6
- data/templates/javadoc/method/html/header.erb +0 -4
- data/templates/javadoc/method/html/title.erb +0 -4
- data/templates/javadoc/methoddetails/html/header.erb +0 -8
- data/templates/javadoc/methoddetails/html/method_header.erb +0 -0
- data/templates/javadoc/methodmissing/html/header.erb +0 -12
- data/templates/javadoc/methodsignature/html/main.erb +0 -8
- data/templates/javadoc/methodsummary/html/header.erb +0 -5
- data/templates/javadoc/methodsummary/html/included.erb +0 -12
- data/templates/javadoc/methodsummary/html/inherited.erb +0 -12
- data/templates/javadoc/methodsummary/html/summary.erb +0 -25
- data/templates/javadoc/mixins/html/header.erb +0 -5
- data/templates/javadoc/module/html/header.erb +0 -4
- data/templates/javadoc/source/html/main.erb +0 -15
- data/templates/javadoc/tags/html/header.erb +0 -5
- data/templates/javadoc/tags/html/see.erb +0 -8
- data/templates/javadoc/tags/html/tags.erb +0 -19
- data/templates/javadoc/visibilitygroup/html/header.erb +0 -5
@@ -0,0 +1,12 @@
|
|
1
|
+
def init
|
2
|
+
sections :header, [T('docstring')], :children, :includes, :extends,
|
3
|
+
:class_meths_list, :instance_meths_list
|
4
|
+
end
|
5
|
+
|
6
|
+
def class_meths
|
7
|
+
@classmeths ||= method_listing.select {|o| o.scope == :class }
|
8
|
+
end
|
9
|
+
|
10
|
+
def instance_meths
|
11
|
+
@instmeths ||= method_listing.select {|o| o.scope == :instance }
|
12
|
+
end
|
@@ -1,20 +1,9 @@
|
|
1
1
|
<% if object.has_tag?(:example) %>
|
2
|
-
<div class="examples">
|
3
|
-
|
4
|
-
<h3>Example: <small><%= object.tag(:example).name %></small></h3>
|
5
|
-
<div class="docstring">
|
6
|
-
<pre class="code"><%= html_syntax_highlight object.tag(:example).text %></pre>
|
7
|
-
</div>
|
8
|
-
<% else %>
|
9
|
-
<h3>Examples</h3>
|
2
|
+
<div class="examples">
|
3
|
+
<h3>Examples:</h3>
|
10
4
|
<% object.tags(:example).each do |tag| %>
|
11
|
-
|
12
|
-
<
|
13
|
-
<dd class="docstring">
|
14
|
-
<pre class="code"><%= html_syntax_highlight tag.text %></pre>
|
15
|
-
</dd>
|
16
|
-
</dl>
|
5
|
+
<h4><%= htmlify_line(tag.name) %></h4>
|
6
|
+
<pre class="example code"><%= html_syntax_highlight(tag.text) %></pre>
|
17
7
|
<% end %>
|
18
|
-
|
19
|
-
</div>
|
8
|
+
</div>
|
20
9
|
<% end %>
|
@@ -1,27 +1,24 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
<
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
<tr>
|
13
|
-
<td class="name"><%= tag.pair.name %></td>
|
14
|
-
<td class="default">
|
1
|
+
<% if object.has_tag?(:option) %>
|
2
|
+
<% object.parameters.each do |param, default| %>
|
3
|
+
<% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s } %>
|
4
|
+
<% next if tags.empty? %>
|
5
|
+
<h3>Options Hash (<tt><%= param %></tt>):</h3>
|
6
|
+
<ul class="option">
|
7
|
+
<% for tag in tags %>
|
8
|
+
<li>
|
9
|
+
<span class="type"><%= format_types (tag.pair.types || ['Object']) %></span>
|
10
|
+
<span class="name"><%= tag.pair.name %></span>
|
11
|
+
<span class="default">
|
15
12
|
<% if tag.pair.defaults %>
|
13
|
+
— default:
|
16
14
|
<%= tag.pair.defaults.map {|t| "<tt>#{h t}</tt>" }.join(", ") %>
|
17
15
|
<% else %>
|
18
16
|
<span class="na">N/A</span>
|
19
17
|
<% end %>
|
20
|
-
</
|
21
|
-
|
22
|
-
<td class="desc"><%= htmlify tag.pair.text %></td>
|
18
|
+
</span>
|
19
|
+
<%= "—" + htmlify_line(tag.pair.text) if tag.pair.text %>
|
23
20
|
</tr>
|
24
21
|
<% end %>
|
25
|
-
</
|
26
|
-
|
27
|
-
|
22
|
+
</ul>
|
23
|
+
<% end %>
|
24
|
+
<% end %>
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<% if object.tags(:overload).size == 1 %>
|
2
|
+
<%= yieldall :object => object.tag(:overload) %>
|
3
|
+
<% elsif object.has_tag?(:overload) %>
|
4
|
+
<h3>Overloads:</h3>
|
5
|
+
<ul class="overload">
|
6
|
+
<% object.tags(:overload).each do |overload| %>
|
7
|
+
<li class="overload_item">
|
8
|
+
<span class="signature"><%= signature(overload, false) %></span>
|
9
|
+
<%= yieldall :object => overload %>
|
10
|
+
</li>
|
11
|
+
<% end %>
|
12
|
+
</ul>
|
13
|
+
<% end %>
|
@@ -1,13 +1,8 @@
|
|
1
1
|
<% if object.has_tag?(:see) %>
|
2
|
-
<div class="see">
|
3
2
|
<h3>See Also:</h3>
|
4
|
-
<
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
</span>
|
10
|
-
</dd>
|
11
|
-
</dl>
|
12
|
-
</div>
|
3
|
+
<ul class="see">
|
4
|
+
<% for tag in object.tags(:see) %>
|
5
|
+
<li><%= linkify(tag.name, tag.text || tag.name) %></li>
|
6
|
+
<% end %>
|
7
|
+
</ul>
|
13
8
|
<% end %>
|
@@ -0,0 +1,20 @@
|
|
1
|
+
<h3><%= @label ? @label : YARD::Tags::Library.labels[@name] %>:</h3>
|
2
|
+
<ul class="<%= @name %>">
|
3
|
+
<% object.tags(@name).each do |tag| %>
|
4
|
+
<li>
|
5
|
+
<% unless @no_types %>
|
6
|
+
<span class='type'><%= format_types(tag.types) %></span>
|
7
|
+
<% end %>
|
8
|
+
<% unless @no_names %>
|
9
|
+
<span class='name'><%= h tag.name %></span>
|
10
|
+
<% end %>
|
11
|
+
<% if @name == :param && (o=object.parameters.assoc(tag.name.to_s)) && o[1] %>
|
12
|
+
<em class="default">(defaults to: <tt><%= h o[1] %></tt>)</em>
|
13
|
+
<% end %>
|
14
|
+
<% if tag.text && !tag.text.empty? %>
|
15
|
+
<% unless (@no_types || tag.types.nil? || tag.types.empty?) && @no_names %>—<% end %>
|
16
|
+
<%= htmlify_line(tag.text) %>
|
17
|
+
<% end %>
|
18
|
+
</li>
|
19
|
+
<% end %>
|
20
|
+
</ul>
|
@@ -0,0 +1,50 @@
|
|
1
|
+
def init
|
2
|
+
sections :index, [:example, :overload, [T('docstring')], :param, :option, :yields,
|
3
|
+
:yieldparam, :yieldreturn, :return, :raises, :see, :author, :since, :version]
|
4
|
+
end
|
5
|
+
|
6
|
+
def param
|
7
|
+
tag :param
|
8
|
+
end
|
9
|
+
|
10
|
+
def yields
|
11
|
+
tag :yield, :no_names => true
|
12
|
+
end
|
13
|
+
|
14
|
+
def yieldparam
|
15
|
+
tag :yieldparam
|
16
|
+
end
|
17
|
+
|
18
|
+
def yieldreturn
|
19
|
+
tag :yieldreturn, :no_names => true
|
20
|
+
end
|
21
|
+
|
22
|
+
def return
|
23
|
+
tag :return, :no_names => true
|
24
|
+
end
|
25
|
+
|
26
|
+
def raises
|
27
|
+
tag :raise, :no_names => true
|
28
|
+
end
|
29
|
+
|
30
|
+
def author
|
31
|
+
tag :author, :no_types => true, :no_names => true
|
32
|
+
end
|
33
|
+
|
34
|
+
def since
|
35
|
+
tag :since, :no_types => true, :no_names => true
|
36
|
+
end
|
37
|
+
|
38
|
+
def version
|
39
|
+
tag :version, :no_types => true, :no_names => true
|
40
|
+
end
|
41
|
+
|
42
|
+
def tag(name, opts = {})
|
43
|
+
return unless object.has_tag?(name)
|
44
|
+
@no_names = true if opts[:no_names]
|
45
|
+
@no_types = true if opts[:no_types]
|
46
|
+
@name = name
|
47
|
+
out = erb('tag')
|
48
|
+
@no_names, @no_types = nil, nil
|
49
|
+
out
|
50
|
+
end
|
@@ -1,14 +1,12 @@
|
|
1
1
|
<% if object.has_tag?(:example) %>
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
<%=
|
9
|
-
<%=
|
10
|
-
<% end %>
|
2
|
+
|
3
|
+
Examples:
|
4
|
+
---------
|
5
|
+
|
6
|
+
<% object.tags(:example).each_with_index do |tag, i| %>
|
7
|
+
<%= indent(wrap("# " + tag.name)) if tag.name %>
|
8
|
+
<%= indent(wrap(format_source(tag.text))) %>
|
9
|
+
<%= "\n" if i < object.tags(:example).size - 1 %>
|
11
10
|
<% end %>
|
12
11
|
<% end %>
|
13
12
|
|
14
|
-
|
@@ -0,0 +1 @@
|
|
1
|
+
<%= yieldall %>
|
@@ -1,5 +1,20 @@
|
|
1
|
-
|
2
|
-
<%
|
3
|
-
|
1
|
+
<% if object.has_tag?(:option) %>
|
2
|
+
<% object.parameters.each do |param, default| %>
|
3
|
+
<% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s } %>
|
4
|
+
<% next if tags.empty? %>
|
5
|
+
Options Hash (<%= param %>):
|
6
|
+
--------------<%= hr(param.to_s.length) %>--
|
7
|
+
|
8
|
+
<% for tag in tags %>
|
9
|
+
<% text = "" %>
|
10
|
+
<% text += format_types(tag.pair.types || ['Object']) %>
|
11
|
+
<% text += " " + tag.pair.name.to_s %>
|
12
|
+
<% if tag.pair.defaults %>
|
13
|
+
<% text += " - default: " + tag.pair.defaults.join(", ") %>
|
4
14
|
<% end %>
|
15
|
+
<% text += " - " + tag.pair.text if tag.pair.text %>
|
16
|
+
<%= indent(wrap(text)) %>
|
5
17
|
|
18
|
+
<% end %>
|
19
|
+
<% end %>
|
20
|
+
<% end %>
|
@@ -0,0 +1,19 @@
|
|
1
|
+
<% if object.tags(:overload).size == 1 %>
|
2
|
+
<%= wrap(yieldall(:object => object.tag(:overload))) %>
|
3
|
+
<% elsif object.has_tag?(:overload) %>
|
4
|
+
Overloads:
|
5
|
+
----------
|
6
|
+
|
7
|
+
<% object.tags(:overload).each do |overload| %>
|
8
|
+
<% if overload.tags.size > 0 %>
|
9
|
+
<%= hr %>
|
10
|
+
|
11
|
+
<%= indent signature(overload) %>
|
12
|
+
|
13
|
+
<%= hr %>
|
14
|
+
|
15
|
+
<%= indent(wrap(yieldall(:object => overload))) %>
|
16
|
+
|
17
|
+
<% end %>
|
18
|
+
<% end %>
|
19
|
+
<% end %>
|
@@ -1,5 +1,11 @@
|
|
1
1
|
<% if object.has_tag?(:see) %>
|
2
|
-
|
3
|
-
|
2
|
+
See Also:
|
3
|
+
---------
|
4
|
+
|
5
|
+
<% for tag in object.tags(:see) %>
|
6
|
+
<% text = "- " + tag.name %>
|
7
|
+
<% text += " - " + tag.text if tag.text && !tag.text.empty? %>
|
8
|
+
<%= indent(wrap(text)) %>
|
9
|
+
<% end %>
|
4
10
|
<% end %>
|
5
11
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<% title = @label ? @label : YARD::Tags::Library.labels[@name] %>
|
2
|
+
<%= title %>:
|
3
|
+
<%= hr(title.length) %>-
|
4
|
+
|
5
|
+
<% object.tags(@name).each do |tag| %>
|
6
|
+
<% text = "" %>
|
7
|
+
<% text += format_types(tag.types) + " " unless @no_types || tag.types.nil? %>
|
8
|
+
<% text += tag.name.to_s + " " unless @no_names %>
|
9
|
+
<% text += "- " unless @no_names && @no_types %>
|
10
|
+
<% text += tag.text if tag.text && !tag.text.empty? %>
|
11
|
+
<%= indent wrap(text) %>
|
12
|
+
|
13
|
+
<% end %>
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.4.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Loren Segal
|
@@ -9,7 +9,7 @@ autorequire:
|
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
11
|
|
12
|
-
date: 2009-
|
12
|
+
date: 2009-11-15 00:00:00 -05:00
|
13
13
|
default_executable:
|
14
14
|
dependencies: []
|
15
15
|
|
@@ -24,22 +24,20 @@ extensions: []
|
|
24
24
|
extra_rdoc_files: []
|
25
25
|
|
26
26
|
files:
|
27
|
-
- docs/
|
28
|
-
- docs/
|
29
|
-
- docs/
|
30
|
-
- docs/
|
31
|
-
- docs/GLOSSARY.markdown
|
32
|
-
- docs/HANDLERS.markdown
|
27
|
+
- docs/CodeObjects.md
|
28
|
+
- docs/GettingStarted.md
|
29
|
+
- docs/Glossary.md
|
30
|
+
- docs/Handlers.md
|
33
31
|
- docs/images/code-objects-class-diagram.png
|
34
32
|
- docs/images/handlers-class-diagram.png
|
35
33
|
- docs/images/overview-class-diagram.png
|
36
34
|
- docs/images/parser-class-diagram.png
|
37
35
|
- docs/images/tags-class-diagram.png
|
38
|
-
- docs/
|
39
|
-
- docs/
|
40
|
-
- docs/
|
41
|
-
- docs/
|
42
|
-
-
|
36
|
+
- docs/Overview.md
|
37
|
+
- docs/Parser.md
|
38
|
+
- docs/Tags.md
|
39
|
+
- docs/Templates.md
|
40
|
+
- docs/WhatsNew.md
|
43
41
|
- bin/yard-graph
|
44
42
|
- bin/yardoc
|
45
43
|
- bin/yri
|
@@ -57,42 +55,12 @@ files:
|
|
57
55
|
- lib/yard/code_objects/namespace_object.rb
|
58
56
|
- lib/yard/code_objects/proxy.rb
|
59
57
|
- lib/yard/code_objects/root_object.rb
|
58
|
+
- lib/yard/core_ext/array.rb
|
60
59
|
- lib/yard/core_ext/file.rb
|
61
60
|
- lib/yard/core_ext/module.rb
|
62
61
|
- lib/yard/core_ext/string.rb
|
63
62
|
- lib/yard/core_ext/symbol_hash.rb
|
64
63
|
- lib/yard/docstring.rb
|
65
|
-
- lib/yard/generators/attributes_generator.rb
|
66
|
-
- lib/yard/generators/base.rb
|
67
|
-
- lib/yard/generators/class_generator.rb
|
68
|
-
- lib/yard/generators/constants_generator.rb
|
69
|
-
- lib/yard/generators/constructor_generator.rb
|
70
|
-
- lib/yard/generators/deprecated_generator.rb
|
71
|
-
- lib/yard/generators/docstring_generator.rb
|
72
|
-
- lib/yard/generators/full_doc_generator.rb
|
73
|
-
- lib/yard/generators/helpers/base_helper.rb
|
74
|
-
- lib/yard/generators/helpers/filter_helper.rb
|
75
|
-
- lib/yard/generators/helpers/html_helper.rb
|
76
|
-
- lib/yard/generators/helpers/html_syntax_highlight_helper.rb
|
77
|
-
- lib/yard/generators/helpers/markup_helper.rb
|
78
|
-
- lib/yard/generators/helpers/method_helper.rb
|
79
|
-
- lib/yard/generators/helpers/uml_helper.rb
|
80
|
-
- lib/yard/generators/inheritance_generator.rb
|
81
|
-
- lib/yard/generators/method_details_generator.rb
|
82
|
-
- lib/yard/generators/method_generator.rb
|
83
|
-
- lib/yard/generators/method_listing_generator.rb
|
84
|
-
- lib/yard/generators/method_missing_generator.rb
|
85
|
-
- lib/yard/generators/method_signature_generator.rb
|
86
|
-
- lib/yard/generators/method_summary_generator.rb
|
87
|
-
- lib/yard/generators/mixins_generator.rb
|
88
|
-
- lib/yard/generators/module_generator.rb
|
89
|
-
- lib/yard/generators/overloads_generator.rb
|
90
|
-
- lib/yard/generators/quick_doc_generator.rb
|
91
|
-
- lib/yard/generators/root_generator.rb
|
92
|
-
- lib/yard/generators/source_generator.rb
|
93
|
-
- lib/yard/generators/tags_generator.rb
|
94
|
-
- lib/yard/generators/uml_generator.rb
|
95
|
-
- lib/yard/generators/visibility_group_generator.rb
|
96
64
|
- lib/yard/globals.rb
|
97
65
|
- lib/yard/handlers/base.rb
|
98
66
|
- lib/yard/handlers/processor.rb
|
@@ -147,6 +115,19 @@ files:
|
|
147
115
|
- lib/yard/tags/ref_tag_list.rb
|
148
116
|
- lib/yard/tags/tag.rb
|
149
117
|
- lib/yard/tags/tag_format_error.rb
|
118
|
+
- lib/yard/templates/engine.rb
|
119
|
+
- lib/yard/templates/helpers/base_helper.rb
|
120
|
+
- lib/yard/templates/helpers/filter_helper.rb
|
121
|
+
- lib/yard/templates/helpers/html_helper.rb
|
122
|
+
- lib/yard/templates/helpers/html_syntax_highlight_helper.rb
|
123
|
+
- lib/yard/templates/helpers/html_syntax_highlight_helper18.rb
|
124
|
+
- lib/yard/templates/helpers/markup_helper.rb
|
125
|
+
- lib/yard/templates/helpers/method_helper.rb
|
126
|
+
- lib/yard/templates/helpers/module_helper.rb
|
127
|
+
- lib/yard/templates/helpers/text_helper.rb
|
128
|
+
- lib/yard/templates/helpers/uml_helper.rb
|
129
|
+
- lib/yard/templates/template.rb
|
130
|
+
- lib/yard/verifier.rb
|
150
131
|
- lib/yard.rb
|
151
132
|
- spec/cli/yardoc_spec.rb
|
152
133
|
- spec/code_objects/base_spec.rb
|
@@ -158,16 +139,12 @@ files:
|
|
158
139
|
- spec/code_objects/namespace_object_spec.rb
|
159
140
|
- spec/code_objects/proxy_spec.rb
|
160
141
|
- spec/code_objects/spec_helper.rb
|
142
|
+
- spec/core_ext/array_spec.rb
|
161
143
|
- spec/core_ext/file_spec.rb
|
144
|
+
- spec/core_ext/module_spec.rb
|
162
145
|
- spec/core_ext/string_spec.rb
|
163
146
|
- spec/core_ext/symbol_hash_spec.rb
|
164
147
|
- spec/docstring_spec.rb
|
165
|
-
- spec/generators/base_spec.rb
|
166
|
-
- spec/generators/full_doc_generator_spec.rb
|
167
|
-
- spec/generators/helpers/base_helper_spec.rb
|
168
|
-
- spec/generators/helpers/html_helper_spec.rb
|
169
|
-
- spec/generators/helpers/markup_helper_spec.rb
|
170
|
-
- spec/generators/quick_doc_generator_spec.rb
|
171
148
|
- spec/handlers/alias_handler_spec.rb
|
172
149
|
- spec/handlers/attribute_handler_spec.rb
|
173
150
|
- spec/handlers/base_spec.rb
|
@@ -222,135 +199,142 @@ files:
|
|
222
199
|
- spec/tags/library_spec.rb
|
223
200
|
- spec/tags/overload_tag_spec.rb
|
224
201
|
- spec/tags/ref_tag_list_spec.rb
|
225
|
-
- templates/
|
226
|
-
- templates/
|
227
|
-
- templates/
|
228
|
-
- templates/
|
229
|
-
- templates/
|
230
|
-
- templates/
|
231
|
-
- templates/
|
232
|
-
- templates/
|
233
|
-
- templates/
|
234
|
-
- templates/
|
235
|
-
- templates/
|
236
|
-
- templates/
|
237
|
-
- templates/
|
238
|
-
- templates/
|
239
|
-
- templates/
|
240
|
-
- templates/
|
241
|
-
- templates/
|
242
|
-
- templates/
|
243
|
-
- templates/
|
244
|
-
- templates/
|
245
|
-
- templates/
|
246
|
-
- templates/
|
247
|
-
- templates/
|
248
|
-
-
|
249
|
-
-
|
250
|
-
- templates/default/
|
251
|
-
- templates/default/
|
252
|
-
- templates/default/
|
202
|
+
- spec/templates/class_spec.rb
|
203
|
+
- spec/templates/engine_spec.rb
|
204
|
+
- spec/templates/examples/class001.html
|
205
|
+
- spec/templates/examples/class001.txt
|
206
|
+
- spec/templates/examples/method001.html
|
207
|
+
- spec/templates/examples/method001.txt
|
208
|
+
- spec/templates/examples/method002.html
|
209
|
+
- spec/templates/examples/method002.txt
|
210
|
+
- spec/templates/examples/method003.html
|
211
|
+
- spec/templates/examples/method003.txt
|
212
|
+
- spec/templates/examples/module001.dot
|
213
|
+
- spec/templates/examples/module001.html
|
214
|
+
- spec/templates/examples/module001.txt
|
215
|
+
- spec/templates/examples/tag001.txt
|
216
|
+
- spec/templates/helpers/base_helper_spec.rb
|
217
|
+
- spec/templates/helpers/html_helper_spec.rb
|
218
|
+
- spec/templates/helpers/html_syntax_highlight_helper_spec.rb
|
219
|
+
- spec/templates/helpers/markup_helper_spec.rb
|
220
|
+
- spec/templates/method_spec.rb
|
221
|
+
- spec/templates/module_spec.rb
|
222
|
+
- spec/templates/spec_helper.rb
|
223
|
+
- spec/templates/tag_spec.rb
|
224
|
+
- spec/templates/template_spec.rb
|
225
|
+
- spec/verifier_spec.rb
|
226
|
+
- spec/yard_spec.rb
|
227
|
+
- templates/default/class/dot/setup.rb
|
228
|
+
- templates/default/class/dot/superklass.erb
|
229
|
+
- templates/default/class/html/constructor_details.erb
|
230
|
+
- templates/default/class/html/setup.rb
|
231
|
+
- templates/default/class/html/subclasses.erb
|
232
|
+
- templates/default/class/setup.rb
|
233
|
+
- templates/default/class/text/setup.rb
|
234
|
+
- templates/default/class/text/subclasses.erb
|
235
|
+
- templates/default/docstring/html/abstract.erb
|
236
|
+
- templates/default/docstring/html/deprecated.erb
|
237
|
+
- templates/default/docstring/html/index.erb
|
238
|
+
- templates/default/docstring/html/note.erb
|
239
|
+
- templates/default/docstring/html/text.erb
|
240
|
+
- templates/default/docstring/html/todo.erb
|
241
|
+
- templates/default/docstring/setup.rb
|
242
|
+
- templates/default/docstring/text/abstract.erb
|
243
|
+
- templates/default/docstring/text/deprecated.erb
|
244
|
+
- templates/default/docstring/text/index.erb
|
245
|
+
- templates/default/docstring/text/note.erb
|
246
|
+
- templates/default/docstring/text/text.erb
|
247
|
+
- templates/default/docstring/text/todo.erb
|
248
|
+
- templates/default/fulldoc/html/css/common.css
|
249
|
+
- templates/default/fulldoc/html/css/full_list.css
|
250
|
+
- templates/default/fulldoc/html/css/style.css
|
251
|
+
- templates/default/fulldoc/html/full_list.erb
|
252
|
+
- templates/default/fulldoc/html/js/app.js
|
253
|
+
- templates/default/fulldoc/html/js/full_list.js
|
254
|
+
- templates/default/fulldoc/html/js/jquery.js
|
255
|
+
- templates/default/fulldoc/html/setup.rb
|
256
|
+
- templates/default/layout/dot/header.erb
|
257
|
+
- templates/default/layout/dot/setup.rb
|
258
|
+
- templates/default/layout/html/breadcrumb.erb
|
259
|
+
- templates/default/layout/html/footer.erb
|
260
|
+
- templates/default/layout/html/headers.erb
|
261
|
+
- templates/default/layout/html/index.erb
|
262
|
+
- templates/default/layout/html/layout.erb
|
263
|
+
- templates/default/layout/html/search.erb
|
264
|
+
- templates/default/layout/html/setup.rb
|
253
265
|
- templates/default/method/html/header.erb
|
254
|
-
- templates/default/method/
|
266
|
+
- templates/default/method/setup.rb
|
255
267
|
- templates/default/method/text/header.erb
|
256
|
-
- templates/default/
|
257
|
-
- templates/default/
|
258
|
-
- templates/default/
|
259
|
-
- templates/default/
|
260
|
-
- templates/default/
|
261
|
-
- templates/default/
|
262
|
-
- templates/default/
|
263
|
-
- templates/default/
|
264
|
-
- templates/default/
|
265
|
-
- templates/default/
|
266
|
-
- templates/default/
|
267
|
-
- templates/default/
|
268
|
-
- templates/default/
|
269
|
-
- templates/default/
|
270
|
-
- templates/default/
|
268
|
+
- templates/default/method_details/html/header.erb
|
269
|
+
- templates/default/method_details/html/method_signature.erb
|
270
|
+
- templates/default/method_details/html/source.erb
|
271
|
+
- templates/default/method_details/setup.rb
|
272
|
+
- templates/default/method_details/text/header.erb
|
273
|
+
- templates/default/method_details/text/method_signature.erb
|
274
|
+
- templates/default/method_details/text/setup.rb
|
275
|
+
- templates/default/module/dot/child.erb
|
276
|
+
- templates/default/module/dot/dependencies.erb
|
277
|
+
- templates/default/module/dot/header.erb
|
278
|
+
- templates/default/module/dot/info.erb
|
279
|
+
- templates/default/module/dot/setup.rb
|
280
|
+
- templates/default/module/html/attribute_details.erb
|
281
|
+
- templates/default/module/html/attribute_summary.erb
|
282
|
+
- templates/default/module/html/box_info.erb
|
283
|
+
- templates/default/module/html/children.erb
|
284
|
+
- templates/default/module/html/constant_summary.erb
|
285
|
+
- templates/default/module/html/defines.erb
|
271
286
|
- templates/default/module/html/header.erb
|
272
|
-
- templates/default/
|
273
|
-
- templates/default/
|
274
|
-
- templates/default/
|
275
|
-
- templates/default/
|
276
|
-
- templates/default/
|
277
|
-
- templates/default/
|
278
|
-
- templates/default/
|
287
|
+
- templates/default/module/html/inherited_constants.erb
|
288
|
+
- templates/default/module/html/inherited_methods.erb
|
289
|
+
- templates/default/module/html/item_summary.erb
|
290
|
+
- templates/default/module/html/method_details_list.erb
|
291
|
+
- templates/default/module/html/method_summary.erb
|
292
|
+
- templates/default/module/html/methodmissing.erb
|
293
|
+
- templates/default/module/html/pre_docstring.erb
|
294
|
+
- templates/default/module/setup.rb
|
295
|
+
- templates/default/module/text/children.erb
|
296
|
+
- templates/default/module/text/class_meths_list.erb
|
297
|
+
- templates/default/module/text/extends.erb
|
298
|
+
- templates/default/module/text/header.erb
|
299
|
+
- templates/default/module/text/includes.erb
|
300
|
+
- templates/default/module/text/instance_meths_list.erb
|
301
|
+
- templates/default/module/text/setup.rb
|
302
|
+
- templates/default/root/dot/child.erb
|
303
|
+
- templates/default/root/dot/setup.rb
|
279
304
|
- templates/default/tags/html/example.erb
|
280
|
-
- templates/default/tags/html/
|
305
|
+
- templates/default/tags/html/index.erb
|
281
306
|
- templates/default/tags/html/option.erb
|
282
|
-
- templates/default/tags/html/
|
307
|
+
- templates/default/tags/html/overload.erb
|
283
308
|
- templates/default/tags/html/see.erb
|
284
|
-
- templates/default/tags/html/
|
285
|
-
- templates/default/tags/
|
309
|
+
- templates/default/tags/html/tag.erb
|
310
|
+
- templates/default/tags/setup.rb
|
286
311
|
- templates/default/tags/text/example.erb
|
287
|
-
- templates/default/tags/text/
|
312
|
+
- templates/default/tags/text/index.erb
|
288
313
|
- templates/default/tags/text/option.erb
|
289
|
-
- templates/default/tags/text/
|
314
|
+
- templates/default/tags/text/overload.erb
|
290
315
|
- templates/default/tags/text/see.erb
|
291
|
-
- templates/default/tags/text/
|
292
|
-
- templates/default/uml/dot/child.erb
|
293
|
-
- templates/default/uml/dot/dependencies.erb
|
294
|
-
- templates/default/uml/dot/header.erb
|
295
|
-
- templates/default/uml/dot/info.erb
|
296
|
-
- templates/default/uml/dot/subgraph.erb
|
297
|
-
- templates/default/uml/dot/superclasses.erb
|
298
|
-
- templates/default/uml/dot/unknown.erb
|
299
|
-
- templates/default/uml/dot/unknown_child.erb
|
300
|
-
- templates/default/visibilitygroup/html/header.erb
|
301
|
-
- templates/javadoc/attributes/html/header.erb
|
302
|
-
- templates/javadoc/class/html/header.erb
|
303
|
-
- templates/javadoc/constants/html/constants.erb
|
304
|
-
- templates/javadoc/constants/html/header.erb
|
305
|
-
- templates/javadoc/constants/html/included.erb
|
306
|
-
- templates/javadoc/constants/html/inherited.erb
|
307
|
-
- templates/javadoc/constructor/html/header.erb
|
308
|
-
- templates/javadoc/deprecated/html/main.erb
|
309
|
-
- templates/javadoc/docstring/html/main.erb
|
310
|
-
- templates/javadoc/fulldoc/html/all_methods.erb
|
311
|
-
- templates/javadoc/fulldoc/html/all_namespaces.erb
|
312
|
-
- templates/javadoc/fulldoc/html/app.js
|
313
|
-
- templates/javadoc/fulldoc/html/header.erb
|
314
|
-
- templates/javadoc/fulldoc/html/html_head.erb
|
315
|
-
- templates/javadoc/fulldoc/html/index.erb
|
316
|
-
- templates/javadoc/fulldoc/html/jquery.js
|
317
|
-
- templates/javadoc/fulldoc/html/readme.erb
|
318
|
-
- templates/javadoc/fulldoc/html/style.css
|
319
|
-
- templates/javadoc/fulldoc/html/syntax_highlight.css
|
320
|
-
- templates/javadoc/inheritance/html/header.erb
|
321
|
-
- templates/javadoc/method/html/aliases.erb
|
322
|
-
- templates/javadoc/method/html/header.erb
|
323
|
-
- templates/javadoc/method/html/title.erb
|
324
|
-
- templates/javadoc/methoddetails/html/header.erb
|
325
|
-
- templates/javadoc/methoddetails/html/method_header.erb
|
326
|
-
- templates/javadoc/methodmissing/html/header.erb
|
327
|
-
- templates/javadoc/methodsignature/html/main.erb
|
328
|
-
- templates/javadoc/methodsummary/html/header.erb
|
329
|
-
- templates/javadoc/methodsummary/html/included.erb
|
330
|
-
- templates/javadoc/methodsummary/html/inherited.erb
|
331
|
-
- templates/javadoc/methodsummary/html/summary.erb
|
332
|
-
- templates/javadoc/mixins/html/header.erb
|
333
|
-
- templates/javadoc/module/html/header.erb
|
334
|
-
- templates/javadoc/source/html/main.erb
|
335
|
-
- templates/javadoc/tags/html/header.erb
|
336
|
-
- templates/javadoc/tags/html/see.erb
|
337
|
-
- templates/javadoc/tags/html/tags.erb
|
338
|
-
- templates/javadoc/visibilitygroup/html/header.erb
|
316
|
+
- templates/default/tags/text/tag.erb
|
339
317
|
- benchmarks/builtins_vs_eval.rb
|
318
|
+
- benchmarks/concat_vs_join.rb
|
340
319
|
- benchmarks/erb_vs_erubis.rb
|
341
320
|
- benchmarks/format_args.rb
|
342
321
|
- benchmarks/generation.rb
|
343
322
|
- benchmarks/marshal_vs_dbm.rb
|
344
323
|
- benchmarks/parsing.rb
|
324
|
+
- benchmarks/pathname_vs_string.rb
|
345
325
|
- benchmarks/rdoc_vs_yardoc.rb
|
346
326
|
- benchmarks/ri_vs_yri.rb
|
347
327
|
- benchmarks/ripper_parser.rb
|
328
|
+
- benchmarks/template_erb.rb
|
329
|
+
- benchmarks/template_format.rb
|
330
|
+
- benchmarks/template_profile.rb
|
331
|
+
- ChangeLog
|
348
332
|
- LICENSE
|
349
|
-
- README.
|
333
|
+
- README.md
|
350
334
|
- Rakefile
|
351
335
|
- .yardopts
|
352
336
|
has_rdoc: yard
|
353
|
-
homepage: http://
|
337
|
+
homepage: http://yardoc.org
|
354
338
|
licenses: []
|
355
339
|
|
356
340
|
post_install_message:
|
@@ -373,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
373
357
|
requirements: []
|
374
358
|
|
375
359
|
rubyforge_project: yard
|
376
|
-
rubygems_version: 1.3.
|
360
|
+
rubygems_version: 1.3.5
|
377
361
|
signing_key:
|
378
362
|
specification_version: 3
|
379
363
|
summary: Documentation tool for consistent and usable documentation in Ruby.
|