Module: YARD::CodeObjects

Relationships & Source Files
Namespace Children
Modules: `NamespaceMapper`
Classes: `Base`, `ClassObject`, `ClassVariableObject`, `CodeObjectList`, `ConstantObject`, `ExtendedMethodObject`, `ExtraFileObject`, `MacroObject`, `MethodObject`, `ModuleObject`, `NamespaceObject`, `Proxy`, `RootObject`
Exceptions: `ProxyMethodError`
Extension / Inclusion / Inheritance Descendants
Included In: `Handlers::Base`, `Handlers::C::AliasHandler`, `Handlers::C::AttributeHandler`, `Handlers::C::Base`, `Handlers::C::ClassHandler`, `Handlers::C::ConstantHandler`, `Handlers::C::HandlerMethods`, `Handlers::C::InitHandler`, `Handlers::C::MethodHandler`, `Handlers::C::MixinHandler`, `Handlers::C::ModuleHandler`, `Handlers::C::OverrideCommentHandler`, `Handlers::C::PathHandler`, `Handlers::C::StructHandler`, `Handlers::C::SymbolHandler`, `Handlers::Ruby::AliasHandler`, `Handlers::Ruby::AttributeHandler`, `Handlers::Ruby::Base`, `Handlers::Ruby::ClassConditionHandler`, `Handlers::Ruby::ClassHandler`, `Handlers::Ruby::ClassVariableHandler`, `Handlers::Ruby::CommentHandler`, `Handlers::Ruby::ConstantHandler`, `Handlers::Ruby::DSLHandler`, `Handlers::Ruby::DSLHandlerMethods`, `Handlers::Ruby::ExceptionHandler`, `Handlers::Ruby::ExtendHandler`, `Handlers::Ruby::Legacy::AliasHandler`, `Handlers::Ruby::Legacy::AttributeHandler`, `Handlers::Ruby::Legacy::Base`, `Handlers::Ruby::Legacy::ClassConditionHandler`, `Handlers::Ruby::Legacy::ClassHandler`, `Handlers::Ruby::Legacy::ClassVariableHandler`, `Handlers::Ruby::Legacy::CommentHandler`, `Handlers::Ruby::Legacy::ConstantHandler`, `Handlers::Ruby::Legacy::DSLHandler`, `Handlers::Ruby::Legacy::ExceptionHandler`, `Handlers::Ruby::Legacy::ExtendHandler`, `Handlers::Ruby::Legacy::MethodHandler`, `Handlers::Ruby::Legacy::MixinHandler`, `Handlers::Ruby::Legacy::ModuleFunctionHandler`, `Handlers::Ruby::Legacy::ModuleHandler`, `Handlers::Ruby::Legacy::PrivateClassMethodHandler`, `Handlers::Ruby::Legacy::PrivateConstantHandler`, `Handlers::Ruby::Legacy::VisibilityHandler`, `Handlers::Ruby::Legacy::YieldHandler`, `Handlers::Ruby::MethodConditionHandler`, `Handlers::Ruby::MethodHandler`, `Handlers::Ruby::MixinHandler`, `Handlers::Ruby::ModuleFunctionHandler`, `Handlers::Ruby::ModuleHandler`, `Handlers::Ruby::PrivateClassMethodHandler`, `Handlers::Ruby::PrivateConstantHandler`, `Handlers::Ruby::PublicClassMethodHandler`, `Handlers::Ruby::StructHandlerMethods`, `Handlers::Ruby::VisibilityHandler`, `Handlers::Ruby::YieldHandler`, `Tags::TypesExplainer::Parser`
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `NamespaceMapper`
Defined in:	lib/yard/autoload.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

Overview

A "code object" is defined as any entity in the Ruby language. Classes, modules, methods, class variables and constants are the major objects, but DSL languages can create their own by inheriting from Base.

Constant Summary

BUILTIN_ALL =

All builtin Ruby classes and modules.

# File 'lib/yard/code_objects/base.rb', line 91
```
BUILTIN_CLASSES + BUILTIN_MODULES
```

BUILTIN_CLASSES =

Note:

MatchingData is a 1.8.x legacy class

All builtin Ruby classes for inheritance tree.

# File 'lib/yard/code_objects/base.rb', line 78

["Array", "Bignum", "Binding", "Class", "Complex",
"ConditionVariable", "Data", "Dir", "Encoding", "Enumerator", "FalseClass",
"Fiber", "File", "Fixnum", "Float", "Hash", "IO", "Integer", "MatchData",
"Method", "Module", "NilClass", "Numeric", "Object", "Proc", "Queue",
"Random", "Range", "Rational", "Regexp", "RubyVM", "SizedQueue", "String",
"Struct", "Symbol", "Thread", "ThreadGroup", "Time", "TracePoint",
"TrueClass", "UnboundMethod"] + BUILTIN_EXCEPTIONS

BUILTIN_EXCEPTIONS =

All builtin Ruby exception classes for inheritance tree.

# File 'lib/yard/code_objects/base.rb', line 67

["ArgumentError", "ClosedQueueError", "EncodingError",
"EOFError", "Exception", "FiberError", "FloatDomainError", "IndexError",
"Interrupt", "IOError", "KeyError", "LoadError", "LocalJumpError",
"NameError", "NoMemoryError", "NoMethodError", "NotImplementedError",
"RangeError", "RegexpError", "RuntimeError", "ScriptError", "SecurityError",
"SignalException", "StandardError", "StopIteration", "SyntaxError",
"SystemCallError", "SystemExit", "SystemStackError", "ThreadError",
"TypeError", "UncaughtThrowError", "ZeroDivisionError"]

BUILTIN_EXCEPTIONS_HASH =

::Hash of BUILTIN_EXCEPTIONS as keys and true as value (for O(1) lookups)

# File 'lib/yard/code_objects/base.rb', line 94
```
BUILTIN_EXCEPTIONS.inject({}) {|h, n| h.update(n => true) }
```

BUILTIN_MODULES =

All builtin Ruby modules for mixin handling.

# File 'lib/yard/code_objects/base.rb', line 87

["Comparable", "Enumerable", "Errno", "FileTest", "GC",
"Kernel", "Marshal", "Math", "ObjectSpace", "Precision", "Process", "Signal"]

CONSTANTMATCH =

Regular expression to match constant name

# File 'lib/yard/code_objects/base.rb', line 52
```
/[A-Z]\w*/
```
CONSTANTSTART =

Regular expression to match the beginning of a constant

# File 'lib/yard/code_objects/base.rb', line 55
```
/^[A-Z]/
```
CSEP =

Class method separator

# File 'lib/yard/code_objects/base.rb', line 46
```
'.'
```
CSEPQ =

Regex-quoted class method separator

# File 'lib/yard/code_objects/base.rb', line 49
```
Regexp.quote CSEP
```
ISEP =

Instance method separator

# File 'lib/yard/code_objects/base.rb', line 40
```
'#'
```
ISEPQ =

Regex-quoted instance method separator

# File 'lib/yard/code_objects/base.rb', line 43
```
ISEP
```
METHODMATCH =

Regular expression to match a fully qualified method def (self.foo, Class.foo).

# File 'lib/yard/code_objects/base.rb', line 64
```
/(?:(?:#{NAMESPACEMATCH}|[a-z]\w*)\s*(?:#{CSEPQ}|#{NSEPQ})\s*)?#{METHODNAMEMATCH}/
```
METHODNAMEMATCH =

Regular expression to match a method name

# File 'lib/yard/code_objects/base.rb', line 61
```
%r{[a-zA-Z_]\w*[!?=]?|[-+~]\@|<<|>>|=~|===?|![=~]?|<=>|[<>]=?|\*\*|[-/+%^&*~`|]|\[\]=?}
```
NAMESPACEMATCH =

Regular expression to match namespaces (const A or complex path A::B)

# File 'lib/yard/code_objects/base.rb', line 58
```
/(?:(?:#{NSEPQ}\s*)?#{CONSTANTMATCH})+/
```
NSEP =

Namespace separator

# File 'lib/yard/code_objects/base.rb', line 34
```
'::'
```
NSEPQ =

Regex-quoted namespace separator

# File 'lib/yard/code_objects/base.rb', line 37
```
NSEP
```

PROXY_MATCH = Internal use only
# File 'lib/yard/code_objects/proxy.rb', line 8

/(?:#{NSEPQ}|#{ISEPQ}|#{CSEPQ})([^#{Regexp.quote(
  (NSEP + ISEP + CSEP).split('').uniq.join
)}]+)$/

Class Method Summary

`NamespaceMapper` - Extended

clear_separators	Clears the map of separators.
default_separator	Gets or sets the default separator value to use when no separator for the namespace can be determined.
register_separator	Registers a separator with an optional set of valid types that must follow the separator lexically.
separators, separators_for_type, separators_match, types_for_separator,
unregister_separator_by_type	Unregisters a separator by a type.

Module: YARD::CodeObjects

Overview

Constant Summary

Class Method Summary

NamespaceMapper - Extended

`NamespaceMapper` - Extended