# YARD 0.9.45 Documentation

# Alphabetic Index

## File Listing

- README
- CHANGELOG
- What's New?
- Getting Started Guide
- Tags Overview
- Architecture Overview
- CodeObjects Architecture
- Parser Architecture
- Handlers Architecture
- Tags Architecture
- Templates Architecture
- LICENSE
- LEGAL

## Tag Listing

The following are a brief list of tags that can be used in YARD formatted documentation. See Tags Overview for information on using tags.

- @abstract
- @api
- @attr
- @attr_reader
- @attr_writer
- @!attribute
- @author
- @deprecated
- @!endgroup
- @example
- @!group
- @!macro
- @!method
- @note
- @option
- @overload
- @param
- @!parse
- @private
- @raise
- @return
- @!scope
- @see
- @since
- @todo
- @version
- @!visibility
- @yield
- @yieldparam
- @yieldreturn

## Namespace Listing A-Z

- Top Level Namespace

- A

- Adapter (YARD::Server)
- AliasHandler (YARD::Handlers::C)
- AliasHandler (YARD::Handlers::Ruby)
- AliasHandler (YARD::Handlers::Ruby::Legacy)
- Array
- AstNode (YARD::Parser::Ruby)
- AttributeDirective (YARD::Tags)
- AttributeHandler (YARD::Handlers::C)
- AttributeHandler (YARD::Handlers::RBS)
- AttributeHandler (YARD::Handlers::Ruby)
- AttributeHandler (YARD::Handlers::Ruby::Legacy)

- B

- Base (YARD::Parser)
- Base (YARD::Handlers)
- Base (YARD::Handlers::C)
- Base (YARD::Serializers)
- Base (YARD::CodeObjects)
- Base (YARD::Handlers::RBS)
- Base (YARD::Handlers::Ruby)
- Base (YARD::Server::Commands)
- Base (YARD::Handlers::Ruby::Legacy)
- BaseHelper (YARD::Templates::Helpers)
- BodyStatement (YARD::Parser::C)

- C

- C (YARD::Handlers)
- C (YARD::Parser)
- CLI (YARD)
- CParser (YARD::Parser::C)
- ClassConditionHandler (YARD::Handlers::Ruby)
- ClassConditionHandler (YARD::Handlers::Ruby::Legacy)
- ClassHandler (YARD::Handlers::C)
- ClassHandler (YARD::Handlers::Ruby)
- ClassHandler (YARD::Handlers::Ruby::Legacy)
- ClassMethods (YARD::Templates::Template)
- ClassNode (YARD::Parser::Ruby)
- ClassObject (YARD::CodeObjects)
- ClassVariableHandler (YARD::Handlers::Ruby)
- ClassVariableHandler (YARD::Handlers::Ruby::Legacy)
- ClassVariableObject (YARD::CodeObjects)
- CodeObjectList (YARD::CodeObjects)
- CodeObjects (YARD)
- Command (YARD::CLI)
- CommandParser (YARD::CLI)
- Commands (YARD::Server)
- Comment (YARD::Parser::C)
- CommentHandler (YARD::Handlers::Ruby)
- CommentHandler (YARD::Handlers::Ruby::Legacy)
- CommentNode (YARD::Parser::Ruby)
- CommentParser (YARD::Parser::C)
- Common (YARD::Handlers)
- ConditionalNode (YARD::Parser::Ruby)
- Config (YARD)
- Config (YARD::CLI)
- ConstantHandler (YARD::Handlers::C)
- ConstantHandler (YARD::Handlers::RBS)
- ConstantHandler (YARD::Handlers::Ruby)
- ConstantHandler (YARD::Handlers::Ruby::Legacy)
- ConstantObject (YARD::CodeObjects)

- D

- DSLHandler (YARD::Handlers::Ruby)
- DSLHandler (YARD::Handlers::Ruby::Legacy)
- DSLHandlerMethods (YARD::Handlers::Ruby)
- DecoratorHandlerMethods (YARD::Handlers::Ruby)
- DefaultFactory (YARD::Tags)
- DefaultTag (YARD::Tags)
- Diff (YARD::CLI)
- Directive (YARD::Tags)
- Display (YARD::CLI)
- DisplayFileCommand (YARD::Server::Commands)
- DisplayObjectCommand (YARD::Server::Commands)
- DocServerHelper (YARD::Server)
- DocServerSerializer (YARD::Server)
- Docstring (YARD)
- DocstringParser (YARD)

- E

- EndGroupDirective (YARD::Tags)
- Engine (YARD::Templates)
- ErbCache (YARD::Templates)
- ExceptionHandler (YARD::Handlers::Ruby)
- ExceptionHandler (YARD::Handlers::Ruby::Legacy)
- ExtendHandler (YARD::Handlers::Ruby)
- ExtendHandler (YARD::Handlers::Ruby::Legacy)
- ExtendedMethodObject (YARD::CodeObjects)
- ExtraFileObject (YARD::CodeObjects)

- F

- File
- FileSystemSerializer (YARD::Serializers)
- FilterHelper (YARD::Templates::Helpers)
- FinishRequest (YARD::Server)
- FormData (YARD::Server::HTTPUtils)
- FramesCommand (YARD::Server::Commands)

- G

- GemIndex (YARD)
- Gems (YARD::CLI)
- Graph (YARD::CLI)
- GraphOptions (YARD::CLI)
- GroupDirective (YARD::Tags)

- H

- HTTPUtils (YARD::Server)
- HandlerAborted (YARD::Handlers)
- HandlerMethods (YARD::Handlers::C)
- Handlers (YARD)
- HandlesExtension (YARD::Handlers::Ruby)
- Hash
- Help (YARD::CLI)
- Helpers (YARD::Templates)
- HtmlEntities (YARD::Templates::Helpers::Markup)
- HtmlHelper (YARD::Templates::Helpers)
- HtmlSyntaxHighlightHelper (YARD::Templates::Helpers)
- HybridMarkdown (YARD::Templates::Helpers::Markup)

- I

- I18n (YARD::CLI)
- I18n (YARD)
- InitHandler (YARD::Handlers::C)
- Insertion

- K

- KeywordNode (YARD::Parser::Ruby)

- L

- Legacy (YARD::Handlers::Ruby)
- Legacy (YARD::Parser::Ruby)
- Library (YARD::Tags)
- LibraryCommand (YARD::Server::Commands)
- LibraryIndexCommand (YARD::Server::Commands)
- LibraryIndexOptions (YARD::Server::Commands)
- LibraryNotPreparedError (YARD::Server)
- LibraryOptions (YARD::Server::Commands)
- LibraryVersion (YARD::Server)
- List (YARD::CLI)
- ListCommand (YARD::Server::Commands)
- LiteralNode (YARD::Parser::Ruby)
- Locale (YARD::I18n)
- Logger (YARD)
- LoopNode (YARD::Parser::Ruby)

- M

- MacroDirective (YARD::Tags)
- MacroObject (YARD::CodeObjects)
- Markup (YARD::Templates::Helpers)
- MarkupHelper (YARD::Templates::Helpers)
- MarkupTypes (YARD::CLI)
- Message (YARD::I18n)
- Messages (YARD::I18n)
- MethodCallNode (YARD::Parser::Ruby)
- MethodCallWrapper (YARD::Handlers::Ruby)
- MethodConditionHandler (YARD::Handlers::Ruby)
- MethodDefinitionNode (YARD::Parser::Ruby)
- MethodDirective (YARD::Tags)
- MethodHandler (YARD::Handlers::C)
- MethodHandler (YARD::Handlers::RBS)
- MethodHandler (YARD::Handlers::Ruby)
- MethodHandler (YARD::Handlers::Ruby::Legacy)
- MethodHandler (YARD::Handlers::Common)
- MethodHelper (YARD::Templates::Helpers)
- MethodObject (YARD::CodeObjects)
- MixinHandler (YARD::Handlers::C)
- MixinHandler (YARD::Handlers::RBS)
- MixinHandler (YARD::Handlers::Ruby)
- MixinHandler (YARD::Handlers::Ruby::Legacy)
- Module
- ModuleFunctionHandler (YARD::Handlers::Ruby)
- ModuleFunctionHandler (YARD::Handlers::Ruby::Legacy)
- ModuleHandler (YARD::Handlers::C)
- ModuleHandler (YARD::Handlers::Ruby)
- ModuleHandler (YARD::Handlers::Ruby::Legacy)
- ModuleHelper (YARD::Templates::Helpers)
- ModuleNode (YARD::Parser::Ruby)
- ModuleObject (YARD::CodeObjects)

- N

- NamespaceHandler (YARD::Handlers::RBS)
- NamespaceMapper (YARD::CodeObjects)
- NamespaceMissingError (YARD::Handlers)
- NamespaceObject (YARD::CodeObjects)
- Node (IRB::SLex)
- NotFoundError (YARD::Server)

- O

- OpenStruct (YARD)
- OptionTag (YARD::Tags)
- Options (YARD)
- OrderedParser (YARD::Parser)
- OverloadTag (YARD::Tags)
- OverrideCommentHandler (YARD::Handlers::C)

- P

- POParser (YARD::I18n)
- ParameterNode (YARD::Parser::Ruby)
- ParseDirective (YARD::Tags)
- Parser (YARD)
- ParserSyntaxError (YARD::Parser)
- PathHandler (YARD::Handlers::C)
- PotGenerator (YARD::I18n)
- PrivateClassMethodHandler (YARD::Handlers::Ruby)
- PrivateClassMethodHandler (YARD::Handlers::Ruby::Legacy)
- PrivateConstantHandler (YARD::Handlers::Ruby)
- PrivateConstantHandler (YARD::Handlers::Ruby::Legacy)
- ProcessSerializer (YARD::Serializers)
- Processor (YARD::Handlers)
- Proxy (YARD::CodeObjects)
- ProxyMethodError (YARD::CodeObjects)
- PublicClassMethodHandler (YARD::Handlers::Ruby)

- R

- RBS (YARD::Handlers)
- RBS (YARD::Parser)
- RDocMarkdown (YARD::Templates::Helpers::Markup)
- RDocMarkup (YARD::Templates::Helpers::Markup)
- RDocMarkupToHtml (YARD::Templates::Helpers::Markup)
- RackAdapter (YARD::Server)
- RackMiddleware (YARD::Server)
- Rake (YARD)
- RbsParser (YARD::Parser::RBS)
- RefTag (YARD::Tags)
- RefTagList (YARD::Tags)
- ReferenceNode (YARD::Parser::Ruby)
- Registry (YARD)
- RegistryResolver (YARD)
- RegistryStore (YARD)
- RipperParser (YARD::Parser::Ruby)
- RootObject (YARD::CodeObjects)
- RootRequestCommand (YARD::Server::Commands)
- Router (YARD::Server)
- Ruby (YARD::Handlers)
- Ruby (YARD::Parser)
- RubyParser (YARD::Parser::Ruby)
- RubyParser (YARD::Parser::Ruby::Legacy)
- RubyToken (YARD::Parser::Ruby::Legacy)

- S

- ScopeDirective (YARD::Tags)
- SearchCommand (YARD::Server::Commands)
- Section (YARD::Templates)
- Serializers (YARD)
- Server (YARD::CLI)
- Server (YARD)
- Severity (YARD::Logger)
- SourceParser (YARD::Parser)
- Statement (YARD::Parser::C)
- Statement (YARD::Parser::RBS)
- Statement (YARD::Parser::Ruby::Legacy)
- StatementList (YARD::Parser::Ruby::Legacy)
- StaticCaching (YARD::Server)
- StaticFileCommand (YARD::Server::Commands)
- StaticFileHelpers (YARD::Server::Commands)
- Stats (YARD::CLI)
- StdoutSerializer (YARD::Serializers)
- String
- StructHandler (YARD::Handlers::C)
- StructHandlerMethods (YARD::Handlers::Ruby)
- SymbolHandler (YARD::Handlers::C)
- SymbolHash

- T

- Tag (YARD::Tags)
- TagFormatError (YARD::Tags)
- Tags (YARD)
- Template (YARD::Templates)
- TemplateOptions (YARD::Templates)
- Templates (YARD)
- TestNodeWrapper (YARD::Handlers::Ruby)
- Text (YARD::I18n)
- TextHelper (YARD::Templates::Helpers)
- TkBlockContents (YARD::Parser::Ruby::Legacy::RubyToken)
- TkError (YARD::Parser::Ruby::Legacy::RubyToken)
- TkId (YARD::Parser::Ruby::Legacy::RubyToken)
- TkKW (YARD::Parser::Ruby::Legacy::RubyToken)
- TkNode (YARD::Parser::Ruby::Legacy::RubyToken)
- TkOPASGN (YARD::Parser::Ruby::Legacy::RubyToken)
- TkOp (YARD::Parser::Ruby::Legacy::RubyToken)
- TkStatementEnd (YARD::Parser::Ruby::Legacy::RubyToken)
- TkUnknownChar (YARD::Parser::Ruby::Legacy::RubyToken)
- TkVal (YARD::Parser::Ruby::Legacy::RubyToken)
- TkWhitespace (YARD::Parser::Ruby::Legacy::RubyToken)
- Token (YARD::Parser::Ruby::Legacy::RubyToken)
- TokenList (YARD::Parser::Ruby::Legacy)
- TokenResolver (YARD::Parser::Ruby)
- ToplevelStatement (YARD::Parser::C)
- TypesExplainer (YARD::Tags)

- U

- UMLHelper (YARD::Templates::Helpers)
- UndocumentableError (YARD::Parser)

- V

- Verifier (YARD)
- VisibilityDirective (YARD::Tags)
- VisibilityHandler (YARD::Handlers::Ruby)
- VisibilityHandler (YARD::Handlers::Ruby::Legacy)

- W

- WebrickAdapter (YARD::Server)
- WebrickServlet (YARD::Server)

- Y

- YARD
- YRI (YARD::CLI)
- Yardoc (YARD::CLI)
- YardocOptions (YARD::CLI)
- YardocSerializer (YARD::Serializers)
- YardocTask (YARD::Rake)
- YardoptsCommand (YARD::CLI)
- YieldHandler (YARD::Handlers::Ruby)
- YieldHandler (YARD::Handlers::Ruby::Legacy)