Documentation for yard (0.8.1)

Alphabetic Index

File Listing

Tag Listing

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

Namespace Listing A-Z

Top Level Namespace

A

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

B

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

C

C (YARD::Parser)
C (YARD::Handlers)
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::Legacy)
ClassVariableHandler (YARD::Handlers::Ruby)
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)
ConditionalNode (YARD::Parser::Ruby)
Config (YARD::CLI)
Config (YARD)
ConstantHandler (YARD::Handlers::C)
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)
DefaultFactory (YARD::Tags)
DefaultTag (YARD::Tags)
Diff (YARD::CLI)
Directive (YARD::Tags)
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::Legacy)
ExceptionHandler (YARD::Handlers::Ruby)
ExtendHandler (YARD::Handlers::Ruby::Legacy)
ExtendHandler (YARD::Handlers::Ruby)
ExtendedMethodObject (YARD::CodeObjects)
ExtraFileObject (YARD::CodeObjects)

F

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

G

Gems (YARD::CLI)
Graph (YARD::CLI)
GroupDirective (YARD::Tags)

H

HandlerMethods (YARD::Handlers::C)
Handlers (YARD)
HandlesExtension (YARD::Handlers::Ruby)
Hash
Help (YARD::CLI)
Helpers (YARD::Templates)
HtmlHelper (YARD::Templates::Helpers)
HtmlSyntaxHighlightHelper (YARD::Templates::Helpers)

I

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

K

KeywordNode (YARD::Parser::Ruby)

L

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

M

MacroDirective (YARD::Tags)
MacroObject (YARD::CodeObjects)
Markup (YARD::Templates::Helpers)
MarkupHelper (YARD::Templates::Helpers)
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::Ruby::Legacy)
MethodHandler (YARD::Handlers::Ruby)
MethodHandler (YARD::Handlers::C)
MethodHelper (YARD::Templates::Helpers)
MethodObject (YARD::CodeObjects)
MixinHandler (YARD::Handlers::C)
MixinHandler (YARD::Handlers::Ruby::Legacy)
MixinHandler (YARD::Handlers::Ruby)
Module
ModuleFunctionHandler (YARD::Handlers::Ruby::Legacy)
ModuleFunctionHandler (YARD::Handlers::Ruby)
ModuleHandler (YARD::Handlers::Ruby)
ModuleHandler (YARD::Handlers::Ruby::Legacy)
ModuleHandler (YARD::Handlers::C)
ModuleHelper (YARD::Templates::Helpers)
ModuleNode (YARD::Parser::Ruby)
ModuleObject (YARD::CodeObjects)

N

NamespaceMissingError (YARD::Handlers)
NamespaceObject (YARD::CodeObjects)
NotFoundError (YARD::Server)

O

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

P

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

R

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

S

ScopeDirective (YARD::Tags)
SearchCommand (YARD::Server::Commands)
Section (YARD::Templates)
Serializers (YARD)
Server (YARD)
Server (YARD::CLI)
SourceParser (YARD::Parser)
Statement (YARD::Parser::Ruby::Legacy)
Statement (YARD::Parser::C)
StatementList (YARD::Parser::Ruby::Legacy)
StaticCaching (YARD::Server)
StaticFileCommand (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)
ToplevelStatement (YARD::Parser::C)

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)
YieldHandler (YARD::Handlers::Ruby::Legacy)
YieldHandler (YARD::Handlers::Ruby)