Class: SleepingKingStudios::Docs::Data::RootObject

Inherits:
NamespaceObject show all
Defined in:
lib/sleeping_king_studios/docs/data/root_object.rb

Overview

Object representing the top-level Ruby namespace.

Each namespace can define the following elements:

  • Definitions (classes and modules).

  • Constants.

  • Class attributes.

  • Class methods.

  • Instance attributes.

  • Instance methods.

See Also:

Instance Method Summary collapse

Methods inherited from NamespaceObject

#as_json, #class_attributes, #class_methods, #constants, #defined_classes, #defined_modules, #instance_attributes, #instance_methods, #type

Methods inherited from Base

#as_json, #initialize

Constructor Details

This class inherits a constructor from SleepingKingStudios::Docs::Data::Base

Instance Method Details

#data_path ⇒ String

The path to the data file.

Returns:

  • (String) —

    the file path.



22
23
24
 
# File 'lib/sleeping_king_studios/docs/data/root_object.rb', line 22

def data_path
  'root'
end

#name ⇒ String

The full, qualified name of the namespace.

Returns:

  • (String) —

    the qualified name.



29
30
31
 
# File 'lib/sleeping_king_studios/docs/data/root_object.rb', line 29

def name
  'root'
end

#slug ⇒ String

The name of the namespace in url-safe format.

Returns:

  • (String) —

    the namespace name.



36
37
38
 
# File 'lib/sleeping_king_studios/docs/data/root_object.rb', line 36

def slug
  'root'
end