Module YARD
In: lib/yard/serializers/file_system_serializer.rb
lib/yard/serializers/process_serializer.rb
lib/yard/serializers/base.rb
lib/yard/serializers/yardoc_serializer.rb
lib/yard/serializers/stdout_serializer.rb
lib/yard/tags/option_tag.rb
lib/yard/tags/ref_tag.rb
lib/yard/tags/library.rb
lib/yard/tags/default_factory.rb
lib/yard/tags/directives.rb
lib/yard/tags/ref_tag_list.rb
lib/yard/tags/tag_format_error.rb
lib/yard/tags/tag.rb
lib/yard/tags/default_tag.rb
lib/yard/tags/overload_tag.rb
lib/yard/registry.rb
lib/yard/rake/yardoc_task.rb
lib/yard/server.rb
lib/yard/verifier.rb
lib/yard/docstring.rb
lib/yard/docstring_parser.rb
lib/yard/options.rb
lib/yard/parser/base.rb
lib/yard/parser/source_parser.rb
lib/yard/parser/c/comment_parser.rb
lib/yard/parser/c/c_parser.rb
lib/yard/parser/c/statement.rb
lib/yard/parser/ruby/ruby_parser.rb
lib/yard/parser/ruby/legacy/statement_list.rb
lib/yard/parser/ruby/legacy/ruby_parser.rb
lib/yard/parser/ruby/legacy/ruby_lex.rb
lib/yard/parser/ruby/legacy/statement.rb
lib/yard/parser/ruby/legacy/token_list.rb
lib/yard/parser/ruby/ast_node.rb
lib/yard/code_objects/proxy.rb
lib/yard/code_objects/base.rb
lib/yard/code_objects/macro_object.rb
lib/yard/code_objects/root_object.rb
lib/yard/i18n/pot_generator.rb
lib/yard/i18n/locale.rb
lib/yard/i18n/messages.rb
lib/yard/i18n/message.rb
lib/yard/i18n/text.rb
lib/yard/config.rb
lib/yard/logging.rb
lib/yard/cli/yri.rb
lib/yard/cli/server.rb
lib/yard/cli/command_parser.rb
lib/yard/cli/graph.rb
lib/yard/cli/gems.rb
lib/yard/cli/command.rb
lib/yard/cli/i18n.rb
lib/yard/cli/help.rb
lib/yard/cli/list.rb
lib/yard/cli/stats.rb
lib/yard/cli/diff.rb
lib/yard/cli/yardoc.rb
lib/yard/cli/config.rb
lib/yard/handlers/processor.rb
lib/yard/handlers/c/handler_methods.rb
lib/yard/handlers/c/base.rb
lib/yard/handlers/ruby/dsl_handler_methods.rb
lib/yard/handlers/ruby/base.rb
lib/yard/handlers/ruby/legacy/dsl_handler.rb
lib/yard/handlers/ruby/legacy/base.rb
lib/yard/handlers/ruby/dsl_handler.rb
lib/yard/handlers/base.rb
lib/yard/templates/template_options.rb
lib/yard/templates/section.rb
lib/yard/templates/helpers/html_helper.rb
lib/yard/templates/helpers/filter_helper.rb
lib/yard/templates/helpers/method_helper.rb
lib/yard/templates/helpers/markup/rdoc_markup.rb
lib/yard/templates/helpers/module_helper.rb
lib/yard/templates/helpers/markup_helper.rb
lib/yard/templates/helpers/text_helper.rb
lib/yard/templates/helpers/html_syntax_highlight_helper.rb
lib/yard/templates/helpers/uml_helper.rb
lib/yard/templates/template.rb
lib/yard/templates/engine.rb
lib/yard/templates/erb_cache.rb
lib/yard/registry_store.rb
lib/yard/autoload.rb
lib/yard/server/commands/list_command.rb
lib/yard/server/commands/frames_command.rb
lib/yard/server/commands/static_file_command.rb
lib/yard/server/commands/library_command.rb
lib/yard/server/commands/display_file_command.rb
lib/yard/server/commands/base.rb
lib/yard/server/commands/search_command.rb
lib/yard/server/commands/display_object_command.rb
lib/yard/server/commands/library_index_command.rb
lib/yard/server/adapter.rb
lib/yard/server/webrick_adapter.rb
lib/yard/server/doc_server_helper.rb
lib/yard/server/rack_adapter.rb
lib/yard/server/router.rb
lib/yard/server/library_version.rb
lib/yard/server/static_caching.rb
lib/yard/server/doc_server_serializer.rb
lib/yard.rb

Methods

Classes and Modules

Module YARD::CLI
Module YARD::CodeObjects
Module YARD::Handlers
Module YARD::I18n
Module YARD::Parser
Module YARD::Rake
Module YARD::Registry
Module YARD::Serializers
Module YARD::Server
Module YARD::Tags
Module YARD::Templates
Class YARD::Config
Class YARD::Docstring
Class YARD::DocstringParser
Class YARD::Logger
Class YARD::Options
Class YARD::RegistryStore
Class YARD::StubProxy
Class YARD::Verifier

Constants

VERSION = "0.8.2.1"
ROOT = File.expand_path(File.dirname(__FILE__))   The root path for YARD source libraries
TEMPLATE_ROOT = File.join(ROOT, '..', 'templates')   The root path for YARD builtin templates
CONFIG_DIR = File.expand_path('~/.yard')   @deprecated Use {Config::CONFIG_DIR}

Public Class methods

An alias to {Parser::SourceParser}’s parsing method

@example Parse a glob of files

  YARD.parse('lib/**/*.rb')

@see Parser::SourceParser.parse

An alias to {Parser::SourceParser}’s parsing method

@example Parse a string of input

  YARD.parse_string('class Foo; end')

@see Parser::SourceParser.parse_string

[Validate]