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

Parent Namespace

SleepingKingStudios::Docs::Data

Defined In

lib/sleeping_king_studios/docs/data/base.rb

Table Of Contents

• Overview
• Direct Subclasses
• Constructor
• Instance Methods
  • as_json
  • initialize

Overview

This class is abstract.

Base object representing a Ruby object documented in YARD.

Back To Top

Direct Subclasses

SleepingKingStudios::Docs::Data::ConstantObject, SleepingKingStudios::Docs::Data::Metadata, SleepingKingStudios::Docs::Data::MethodObject, SleepingKingStudios::Docs::Data::NamespaceObject, SleepingKingStudios::Docs::Data::SeeTags::Base

Back To Top

Constructor

#initialize(native:) => Base

Parameters

• native (YARD::Tags::Tag) — the YARD object representing the documented object.

Returns

• (Base) — a new instance of Base

Back To Top

Instance Methods

#as_json => Hash

Generates a JSON-compatible representation of the object.

Returns

• (Hash) — the JSON representation.

Back To Top

---

Back to Documentation | Versions | 0.2 | Reference | SleepingKingStudios | SleepingKingStudios::Docs | SleepingKingStudios::Docs::Data