Class: YARD::CodeObjects::RootObject
- Inherits:
-
ModuleObject
- Object
- Base
- NamespaceObject
- ModuleObject
- YARD::CodeObjects::RootObject
- Defined in:
- lib/yard/code_objects/root_object.rb
Overview
Represents the root namespace object (the invisible Ruby module that holds all top level modules, class and other objects).
Instance Attribute Summary (collapse)
-
- (Hash) aliases
inherited
from NamespaceObject
readonly
A hash containing two keys, :class and :instance, each containing a hash of objects and their alias names.
-
- (Hash) attributes
inherited
from NamespaceObject
readonly
A hash containing two keys, class and instance, each containing the attribute name with a { :read, :write } hash for the read and write objects respectively.
-
- (Docstring) base_docstring
inherited
from Base
readonly
The non-localized documentation string associated with the object.
-
- (Base?) child(opts = {})
inherited
from NamespaceObject
Looks for a child that matches the attributes specified by
opts
. -
- (Array<Base>) children
inherited
from NamespaceObject
readonly
The list of objects defined in this namespace.
-
- (Hash) class_attributes
inherited
from NamespaceObject
Only the class attributes.
-
- (Array<ModuleObject>) class_mixins
inherited
from NamespaceObject
readonly
Class mixins.
-
- (Array<ConstantObject>) constants(opts = {})
inherited
from NamespaceObject
Returns all constants in the namespace.
-
- (Array<ClassVariableObject>) cvars
inherited
from NamespaceObject
Returns class variables defined in this namespace.
-
- (Boolean) dynamic
inherited
from Base
Marks whether or not the method is conditionally defined at runtime.
-
- (Array<String>) files
inherited
from Base
readonly
The files the object was defined in.
-
- (String) group
inherited
from Base
The group this object is associated with.
-
- (Array<String>) groups
inherited
from NamespaceObject
A list of ordered group names inside the namespace.
-
- (Array<ConstantObject>) included_constants
inherited
from NamespaceObject
Returns constants included from any mixins.
-
- (Object) included_meths(opts = {})
inherited
from NamespaceObject
Returns methods included from any mixins that match the attributes specified by
opts
. -
- (Hash) instance_attributes
inherited
from NamespaceObject
Only the instance attributes.
-
- (Array<ModuleObject>) instance_mixins
inherited
from NamespaceObject
readonly
Instance mixins.
-
- (Array<MethodObject>) meths(opts = {})
inherited
from NamespaceObject
Returns all methods that match the attributes specified by
opts
. -
- (Array<ModuleObject>) mixins(*scopes)
inherited
from NamespaceObject
Returns for specific scopes.
-
- (NamespaceObject) namespace
(also: #parent)
inherited
from Base
The namespace the object is defined in.
-
- (String) signature
inherited
from Base
The one line signature representing an object.
-
- (String?) source
inherited
from Base
The source code associated with the object.
-
- (Symbol) source_type
inherited
from Base
Language of the source code associated with the object.
-
- (Symbol) visibility
inherited
from Base
The visibility of an object (:public, :private, :protected).
Instance Method Summary (collapse)
- - (Boolean) equal?(other)
- - (Object) hash
- - (Object) inspect
- - (Object) path
- - (Boolean) root?
- - (Object) title
Constructor Details
This class inherits a constructor from YARD::CodeObjects::NamespaceObject
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class YARD::CodeObjects::Base
Instance Attribute Details
- (Hash) aliases (readonly) Originally defined in class NamespaceObject
A hash containing two keys, :class and :instance, each containing a hash of objects and their alias names.
- (Hash) attributes (readonly) Originally defined in class NamespaceObject
A hash containing two keys, class and instance, each containing the attribute name with a { :read, :write } hash for the read and write objects respectively.
- (Docstring) base_docstring (readonly) Originally defined in class Base
The non-localized documentation string associated with the object
- (Base?) child(opts = {}) Originally defined in class NamespaceObject
Looks for a child that matches the attributes specified by
opts
.
- (Array<Base>) children (readonly) Originally defined in class NamespaceObject
The list of objects defined in this namespace
- (Hash) class_attributes Originally defined in class NamespaceObject
Only the class attributes
- (Array<ModuleObject>) class_mixins (readonly) Originally defined in class NamespaceObject
Class mixins
- (Array<ConstantObject>) constants(opts = {}) Originally defined in class NamespaceObject
Returns all constants in the namespace
- (Array<ClassVariableObject>) cvars Originally defined in class NamespaceObject
Returns class variables defined in this namespace.
- (Boolean) dynamic Originally defined in class Base
Marks whether or not the method is conditionally defined at runtime
- (Array<String>) files (readonly) Originally defined in class Base
The files the object was defined in. To add a file, use #add_file.
- (Array<String>) groups Originally defined in class NamespaceObject
Returns a list of ordered group names inside the namespace
- (Array<ConstantObject>) included_constants Originally defined in class NamespaceObject
Returns constants included from any mixins
- (Object) included_meths(opts = {}) Originally defined in class NamespaceObject
Returns methods included from any mixins that match the attributes
specified by opts
. If no options are specified, returns all
included methods.
- (Hash) instance_attributes Originally defined in class NamespaceObject
Only the instance attributes
- (Array<ModuleObject>) instance_mixins (readonly) Originally defined in class NamespaceObject
Instance mixins
- (Array<MethodObject>) meths(opts = {}) Originally defined in class NamespaceObject
Returns all methods that match the attributes specified by
opts
. If no options are provided, returns all methods.
- (Array<ModuleObject>) mixins(*scopes) Originally defined in class NamespaceObject
Returns for specific scopes. If no scopes are provided, returns all mixins.
- (NamespaceObject) namespace Also known as: parent Originally defined in class Base
The namespace the object is defined in. If the object is in the top level namespace, this is Registry.root
- (String) signature Originally defined in class Base
The one line signature representing an object. For a method, this will be of the form “def meth(arguments…)”. This is usually the first source line.
- (Symbol) source_type Originally defined in class Base
Language of the source code associated with the object. Defaults to
:ruby
.
- (Symbol) visibility Originally defined in class Base
Returns the visibility of an object (:public, :private, :protected)
Instance Method Details
- (Boolean) equal?(other)
10 11 12 |
# File 'lib/yard/code_objects/root_object.rb', line 10 def equal?(other) other == :root ? true : super(other) end |
- (Object) hash
14 |
# File 'lib/yard/code_objects/root_object.rb', line 14 def hash; :root.hash end |
- (Object) inspect
7 |
# File 'lib/yard/code_objects/root_object.rb', line 7 def inspect; @inspect ||= "#<yardoc root>" end |
- (Object) path
6 |
# File 'lib/yard/code_objects/root_object.rb', line 6 def path; @path ||= "" end |
- (Boolean) root?
8 |
# File 'lib/yard/code_objects/root_object.rb', line 8 def root?; true end |
- (Object) title
9 |
# File 'lib/yard/code_objects/root_object.rb', line 9 def title; 'Top Level Namespace' end |