Class: SleepingKingStudios::Docs::Data::Base Abstract

Inherits:

Object

• Object
• SleepingKingStudios::Docs::Data::Base

Defined in:

lib/sleeping_king_studios/docs/data/base.rb

Overview

This class is abstract.

Base object representing a Ruby object documented in YARD.

Direct Known Subclasses

ConstantObject, Metadata, MethodObject, NamespaceObject, SeeTags::Base

Instance Method Summary

• #as_json ⇒ Hash

  Generates a JSON-compatible representation of the object.

• #initialize(native:) ⇒ Base constructor

  A new instance of Base.

Constructor Details

#initialize(native:) ⇒ Base

Returns a new instance of Base.

Parameters:

• native (YARD::Tags::Tag) —

  the YARD object representing the documented object.

# File 'lib/sleeping_king_studios/docs/data/base.rb', line 14

def initialize(native:)
  @native   = native
  @registry = SleepingKingStudios::Docs::Registry.instance
end

Instance Method Details

#as_json ⇒ Hash

Generates a JSON-compatible representation of the object.

Returns:

• (Hash) —

  the JSON representation.

# File 'lib/sleeping_king_studios/docs/data/base.rb', line 22

def as_json
  {}
end