Class: SleepingKingStudios::Docs::Yard::Registry

Parent Namespace

SleepingKingStudios::Docs::Yard

Inherited Classes

Data > Object

Included Modules

Enumerable

Defined In

lib/sleeping_king_studios/docs/yard/registry.rb

Table Of Contents

• Overview
• Constants
  • EMPTY
• Class Methods
  • build
  • provider
• Constructor
• Instance Methods
  • each
  • initialize

Overview

Dependency injection provider wrapping the YARD registry.

Back To Top

Constants

EMPTY

= new

Back To Top

Class Methods

.build => SleepingKingStudios::Docs::Yard::Registry

Returns

• (SleepingKingStudios::Docs::Yard::Registry) — a new registry instance wrapping the current YARD state.

.provider => Plumbum::Provider<SleepingKingStudios::Docs::Registry>

Provides an injectable instance of the repository wrapper.

Returns

• (Plumbum::Provider<SleepingKingStudios::Docs::Registry>) — the registry provider.

Back To Top

Constructor

#initialize(items: []) => Registry

Parameters

• items (Array<YARD::CodeObjects::Base>) — the defined YARD objects.

Returns

• (Registry) — a new instance of Registry

Back To Top

Instance Methods

#each => Enumerator
#each(&block) => Object

Overloads

#each => Enumerator

Returns

• (Enumerator) — an enumerator that iterates over the registry items.

#each(&block) => Object

Yields

• (YARD::CodeObjects::Base) — each item in the registry.

Back To Top

---

Back to Documentation | Reference | SleepingKingStudios | SleepingKingStudios::Docs | SleepingKingStudios::Docs::Yard