Metadata

Name
yard
Version
0.9.37
Platform
ruby
Authors
Loren Segal
Bindir
bin
Date
2024-09-04 00:00:00 UTC
Description
YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions.
Email
lsegal@soen.ca
Executables
yard
yardoc
yri
Files
.yardopts
.yardopts_guide
.yardopts_i18n
CHANGELOG.md
LEGAL
LICENSE
README.md
bin/yard
bin/yardoc
bin/yri
docs/CodeObjects.md
docs/GettingStarted.md
docs/Handlers.md
docs/Overview.md
docs/Parser.md
docs/Tags.md
docs/TagsArch.md
docs/Templates.md
docs/WhatsNew.md
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/templates/default/fulldoc/html/full_list_tag.erb
docs/templates/default/fulldoc/html/setup.rb
docs/templates/default/layout/html/setup.rb
docs/templates/default/layout/html/tag_list.erb
docs/templates/default/yard_tags/html/list.erb
docs/templates/default/yard_tags/html/setup.rb
docs/templates/plugin.rb
lib/rubygems_plugin.rb
lib/yard.rb
lib/yard/autoload.rb
lib/yard/cli/command.rb
lib/yard/cli/command_parser.rb
lib/yard/cli/config.rb
lib/yard/cli/diff.rb
lib/yard/cli/display.rb
lib/yard/cli/gems.rb
lib/yard/cli/graph.rb
lib/yard/cli/help.rb
lib/yard/cli/i18n.rb
lib/yard/cli/list.rb
lib/yard/cli/markup_types.rb
lib/yard/cli/server.rb
lib/yard/cli/stats.rb
lib/yard/cli/yardoc.rb
lib/yard/cli/yardopts_command.rb
lib/yard/cli/yri.rb
lib/yard/code_objects/base.rb
lib/yard/code_objects/class_object.rb
lib/yard/code_objects/class_variable_object.rb
lib/yard/code_objects/constant_object.rb
lib/yard/code_objects/extended_method_object.rb
lib/yard/code_objects/extra_file_object.rb
lib/yard/code_objects/macro_object.rb
lib/yard/code_objects/method_object.rb
lib/yard/code_objects/module_object.rb
lib/yard/code_objects/namespace_mapper.rb
lib/yard/code_objects/namespace_object.rb
lib/yard/code_objects/proxy.rb
lib/yard/code_objects/root_object.rb
lib/yard/config.rb
lib/yard/core_ext/array.rb
lib/yard/core_ext/file.rb
lib/yard/core_ext/hash.rb
lib/yard/core_ext/insertion.rb
lib/yard/core_ext/module.rb
lib/yard/core_ext/string.rb
lib/yard/core_ext/symbol_hash.rb
lib/yard/docstring.rb
lib/yard/docstring_parser.rb
lib/yard/gem_index.rb
lib/yard/globals.rb
lib/yard/handlers/base.rb
lib/yard/handlers/c/alias_handler.rb
lib/yard/handlers/c/attribute_handler.rb
lib/yard/handlers/c/base.rb
lib/yard/handlers/c/class_handler.rb
lib/yard/handlers/c/constant_handler.rb
lib/yard/handlers/c/handler_methods.rb
lib/yard/handlers/c/init_handler.rb
lib/yard/handlers/c/method_handler.rb
lib/yard/handlers/c/mixin_handler.rb
lib/yard/handlers/c/module_handler.rb
lib/yard/handlers/c/override_comment_handler.rb
lib/yard/handlers/c/path_handler.rb
lib/yard/handlers/c/struct_handler.rb
lib/yard/handlers/c/symbol_handler.rb
lib/yard/handlers/common/method_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/comment_handler.rb
lib/yard/handlers/ruby/constant_handler.rb
lib/yard/handlers/ruby/decorator_handler_methods.rb
lib/yard/handlers/ruby/dsl_handler.rb
lib/yard/handlers/ruby/dsl_handler_methods.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_condition_handler.rb
lib/yard/handlers/ruby/legacy/class_handler.rb
lib/yard/handlers/ruby/legacy/class_variable_handler.rb
lib/yard/handlers/ruby/legacy/comment_handler.rb
lib/yard/handlers/ruby/legacy/constant_handler.rb
lib/yard/handlers/ruby/legacy/dsl_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_function_handler.rb
lib/yard/handlers/ruby/legacy/module_handler.rb
lib/yard/handlers/ruby/legacy/private_class_method_handler.rb
lib/yard/handlers/ruby/legacy/private_constant_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_function_handler.rb
lib/yard/handlers/ruby/module_handler.rb
lib/yard/handlers/ruby/private_class_method_handler.rb
lib/yard/handlers/ruby/private_constant_handler.rb
lib/yard/handlers/ruby/public_class_method_handler.rb
lib/yard/handlers/ruby/struct_handler_methods.rb
lib/yard/handlers/ruby/visibility_handler.rb
lib/yard/handlers/ruby/yield_handler.rb
lib/yard/i18n/locale.rb
lib/yard/i18n/message.rb
lib/yard/i18n/messages.rb
lib/yard/i18n/po_parser.rb
lib/yard/i18n/pot_generator.rb
lib/yard/i18n/text.rb
lib/yard/logging.rb
lib/yard/open_struct.rb
lib/yard/options.rb
lib/yard/parser/base.rb
lib/yard/parser/c/c_parser.rb
lib/yard/parser/c/comment_parser.rb
lib/yard/parser/c/statement.rb
lib/yard/parser/ruby/ast_node.rb
lib/yard/parser/ruby/legacy/irb/slex.rb
lib/yard/parser/ruby/legacy/ruby_lex.rb
lib/yard/parser/ruby/legacy/ruby_parser.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/ruby/token_resolver.rb
lib/yard/parser/source_parser.rb
lib/yard/rake/yardoc_task.rb
lib/yard/registry.rb
lib/yard/registry_resolver.rb
lib/yard/registry_store.rb
lib/yard/rubygems/backports.rb
lib/yard/rubygems/backports/LICENSE.txt
lib/yard/rubygems/backports/MIT.txt
lib/yard/rubygems/backports/gem.rb
lib/yard/rubygems/backports/source_index.rb
lib/yard/rubygems/doc_manager.rb
lib/yard/rubygems/hook.rb
lib/yard/rubygems/specification.rb
lib/yard/serializers/base.rb
lib/yard/serializers/file_system_serializer.rb
lib/yard/serializers/process_serializer.rb
lib/yard/serializers/stdout_serializer.rb
lib/yard/serializers/yardoc_serializer.rb
lib/yard/server.rb
lib/yard/server/adapter.rb
lib/yard/server/commands/base.rb
lib/yard/server/commands/display_file_command.rb
lib/yard/server/commands/display_object_command.rb
lib/yard/server/commands/frames_command.rb
lib/yard/server/commands/library_command.rb
lib/yard/server/commands/library_index_command.rb
lib/yard/server/commands/list_command.rb
lib/yard/server/commands/root_request_command.rb
lib/yard/server/commands/search_command.rb
lib/yard/server/commands/static_file_command.rb
lib/yard/server/commands/static_file_helpers.rb
lib/yard/server/doc_server_helper.rb
lib/yard/server/doc_server_serializer.rb
lib/yard/server/http_utils.rb
lib/yard/server/library_version.rb
lib/yard/server/rack_adapter.rb
lib/yard/server/router.rb
lib/yard/server/static_caching.rb
lib/yard/server/templates/default/fulldoc/html/css/custom.css
lib/yard/server/templates/default/fulldoc/html/images/processing.gif
lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js
lib/yard/server/templates/default/layout/html/breadcrumb.erb
lib/yard/server/templates/default/layout/html/script_setup.erb
lib/yard/server/templates/default/layout/html/setup.rb
lib/yard/server/templates/default/method_details/html/permalink.erb
lib/yard/server/templates/default/method_details/html/setup.rb
lib/yard/server/templates/doc_server/library_list/html/headers.erb
lib/yard/server/templates/doc_server/library_list/html/library_list.erb
lib/yard/server/templates/doc_server/library_list/html/listing.erb
lib/yard/server/templates/doc_server/library_list/html/setup.rb
lib/yard/server/templates/doc_server/library_list/html/title.erb
lib/yard/server/templates/doc_server/processing/html/processing.erb
lib/yard/server/templates/doc_server/processing/html/setup.rb
lib/yard/server/templates/doc_server/search/html/search.erb
lib/yard/server/templates/doc_server/search/html/setup.rb
lib/yard/server/webrick_adapter.rb
lib/yard/tags/default_factory.rb
lib/yard/tags/default_tag.rb
lib/yard/tags/directives.rb
lib/yard/tags/library.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/tags/types_explainer.rb
lib/yard/templates/engine.rb
lib/yard/templates/erb_cache.rb
lib/yard/templates/helpers/base_helper.rb
lib/yard/templates/helpers/filter_helper.rb
lib/yard/templates/helpers/html_helper.rb
lib/yard/templates/helpers/html_syntax_highlight_helper.rb
lib/yard/templates/helpers/markup/rdoc_markdown.rb
lib/yard/templates/helpers/markup/rdoc_markup.rb
lib/yard/templates/helpers/markup_helper.rb
lib/yard/templates/helpers/method_helper.rb
lib/yard/templates/helpers/module_helper.rb
lib/yard/templates/helpers/text_helper.rb
lib/yard/templates/helpers/uml_helper.rb
lib/yard/templates/section.rb
lib/yard/templates/template.rb
lib/yard/templates/template_options.rb
lib/yard/verifier.rb
lib/yard/version.rb
po/ja.po
templates/default/class/dot/setup.rb
templates/default/class/dot/superklass.erb
templates/default/class/html/constructor_details.erb
templates/default/class/html/setup.rb
templates/default/class/html/subclasses.erb
templates/default/class/setup.rb
templates/default/class/text/setup.rb
templates/default/class/text/subclasses.erb
templates/default/constant/text/header.erb
templates/default/constant/text/setup.rb
templates/default/docstring/html/abstract.erb
templates/default/docstring/html/deprecated.erb
templates/default/docstring/html/index.erb
templates/default/docstring/html/note.erb
templates/default/docstring/html/private.erb
templates/default/docstring/html/returns_void.erb
templates/default/docstring/html/text.erb
templates/default/docstring/html/todo.erb
templates/default/docstring/setup.rb
templates/default/docstring/text/abstract.erb
templates/default/docstring/text/deprecated.erb
templates/default/docstring/text/index.erb
templates/default/docstring/text/note.erb
templates/default/docstring/text/private.erb
templates/default/docstring/text/returns_void.erb
templates/default/docstring/text/text.erb
templates/default/docstring/text/todo.erb
templates/default/fulldoc/html/css/common.css
templates/default/fulldoc/html/css/full_list.css
templates/default/fulldoc/html/css/style.css
templates/default/fulldoc/html/frames.erb
templates/default/fulldoc/html/full_list.erb
templates/default/fulldoc/html/full_list_class.erb
templates/default/fulldoc/html/full_list_file.erb
templates/default/fulldoc/html/full_list_method.erb
templates/default/fulldoc/html/js/app.js
templates/default/fulldoc/html/js/full_list.js
templates/default/fulldoc/html/js/jquery.js
templates/default/fulldoc/html/setup.rb
templates/default/layout/dot/header.erb
templates/default/layout/dot/setup.rb
templates/default/layout/html/breadcrumb.erb
templates/default/layout/html/files.erb
templates/default/layout/html/footer.erb
templates/default/layout/html/headers.erb
templates/default/layout/html/index.erb
templates/default/layout/html/layout.erb
templates/default/layout/html/listing.erb
templates/default/layout/html/objects.erb
templates/default/layout/html/script_setup.erb
templates/default/layout/html/search.erb
templates/default/layout/html/setup.rb
templates/default/method/html/header.erb
templates/default/method/setup.rb
templates/default/method/text/header.erb
templates/default/method_details/html/header.erb
templates/default/method_details/html/method_signature.erb
templates/default/method_details/html/source.erb
templates/default/method_details/setup.rb
templates/default/method_details/text/header.erb
templates/default/method_details/text/method_signature.erb
templates/default/method_details/text/setup.rb
templates/default/module/dot/child.erb
templates/default/module/dot/dependencies.erb
templates/default/module/dot/header.erb
templates/default/module/dot/info.erb
templates/default/module/dot/setup.rb
templates/default/module/html/attribute_details.erb
templates/default/module/html/attribute_summary.erb
templates/default/module/html/box_info.erb
templates/default/module/html/children.erb
templates/default/module/html/constant_summary.erb
templates/default/module/html/defines.erb
templates/default/module/html/header.erb
templates/default/module/html/inherited_attributes.erb
templates/default/module/html/inherited_constants.erb
templates/default/module/html/inherited_methods.erb
templates/default/module/html/item_summary.erb
templates/default/module/html/method_details_list.erb
templates/default/module/html/method_summary.erb
templates/default/module/html/methodmissing.erb
templates/default/module/html/pre_docstring.erb
templates/default/module/setup.rb
templates/default/module/text/children.erb
templates/default/module/text/class_meths_list.erb
templates/default/module/text/extends.erb
templates/default/module/text/header.erb
templates/default/module/text/includes.erb
templates/default/module/text/instance_meths_list.erb
templates/default/module/text/setup.rb
templates/default/onefile/html/files.erb
templates/default/onefile/html/headers.erb
templates/default/onefile/html/layout.erb
templates/default/onefile/html/readme.erb
templates/default/onefile/html/setup.rb
templates/default/root/dot/child.erb
templates/default/root/dot/setup.rb
templates/default/root/html/setup.rb
templates/default/tags/html/example.erb
templates/default/tags/html/index.erb
templates/default/tags/html/option.erb
templates/default/tags/html/overload.erb
templates/default/tags/html/see.erb
templates/default/tags/html/tag.erb
templates/default/tags/setup.rb
templates/default/tags/text/example.erb
templates/default/tags/text/index.erb
templates/default/tags/text/option.erb
templates/default/tags/text/overload.erb
templates/default/tags/text/see.erb
templates/default/tags/text/tag.erb
templates/guide/class/html/setup.rb
templates/guide/docstring/html/setup.rb
templates/guide/fulldoc/html/css/style.css
templates/guide/fulldoc/html/js/app.js
templates/guide/fulldoc/html/setup.rb
templates/guide/layout/html/layout.erb
templates/guide/layout/html/setup.rb
templates/guide/method/html/header.erb
templates/guide/method/html/setup.rb
templates/guide/module/html/header.erb
templates/guide/module/html/method_list.erb
templates/guide/module/html/setup.rb
templates/guide/onefile/html/files.erb
templates/guide/onefile/html/setup.rb
templates/guide/onefile/html/toc.erb
templates/guide/tags/html/setup.rb
Homepage
http://yardoc.org
Licenses
MIT
Metadata
{"yard.run"=>"yri"}
Require paths
lib
Required ruby version
>= 0
Required rubygems version
>= 0
Rubygems version
3.3.5
Specification version
4
Summary
Documentation tool for consistent and usable documentation in Ruby.
Original platform
ruby
New platform
ruby