Class: YARD::CodeObjects::RootObject

Inherits:
ModuleObject show all
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

Attributes inherited from NamespaceObject

#aliases, #attributes, #child, #children, #class_attributes, #class_mixins, #constants, #cvars, #groups, #included_constants, #included_meths, #instance_attributes, #instance_mixins, #meths, #mixins

Attributes inherited from Base

#docstring, #dynamic, #files, #group, #namespace, #signature, #source, #source_type, #visibility

Instance Method Summary (collapse)

Methods inherited from ModuleObject

#inheritance_tree

Methods inherited from NamespaceObject

#initialize

Methods inherited from Base

===, #[], #[]=, #add_file, #dynamic?, #file, #format, #format_source, #has_tag?, #initialize, #line, #method_missing, #name, new, #relative_path, #sep, #tag, #tags, #to_ary, #type

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 Method Details

- (Boolean) equal?(other)

Returns:

  • (Boolean)


9
10
11
# File 'lib/yard/code_objects/root_object.rb', line 9

def equal?(other)
  other == :root ? true : super(other)
end

- (Object) hash



13
# File 'lib/yard/code_objects/root_object.rb', line 13

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?

Returns:

  • (Boolean)


8
# File 'lib/yard/code_objects/root_object.rb', line 8

def root?; true end