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 Method Summary collapse

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

#equal?(other) ⇒ Boolean

Returns:

  • (Boolean)

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

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

#hashObject


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

def hash; :root.hash end

#inspectObject


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

def inspect; @inspect ||= "#<yardoc root>" end

#pathObject


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

def path; @path ||= "" end

#root?Boolean

Returns:

  • (Boolean)

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

def root?; true end

#titleObject


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

def title; 'Top Level Namespace' end