Class: SleepingKingStudios::Docs::Data::ConstantObject

Parent Namespace

SleepingKingStudios::Docs::Data

Inherited Classes

SleepingKingStudios::Docs::Data::Base > Object

Defined In

lib/sleeping_king_studios/docs/data/constant_object.rb

Table Of Contents

• Overview
• Constructor
• Instance Methods
  • as_json
  • data_path
  • description
  • initialize
  • metadata
  • name
  • parent_path
  • short_description
  • slug
  • value

Overview

Object representing a Ruby constant.

Each constant has a name and a value. In addition, a constant may have a short description, a full description, and metadata.

Back To Top

Constructor

#initialize(native:) => Base

Inherited From

SleepingKingStudios::Docs::Data::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{String => Object}

Generates a JSON-compatible representation of the constant.

Returns a Hash with the following keys:

• ‘name’: The full, qualified name of the constant.
• ‘slug’: The name of the constant in url-safe format.
• ‘value’: A String representation of the value of the constant.
• ‘short_description’: A short description of the constant.

Additionally, the returned Hash will conditionally include the following keys, if the constant defines at least one of the corresponding code objects.

• ‘description’: The full description of the constant, minus the first clause.
• ‘metadata’: Additional metadata tags from the documentation.

Returns

• (Hash{String => Object}) — the representation of the constant.

#data_path => String

The path to the data file.

Returns

• (String) — the file path.

#description => String

The full description of the constant, minus the first clause.

The remainder of the constant description, if any, after subtracting the short description (separated by the first paragraph break).

Returns

• (String) — the remaining description.

See Also

• #short_description

#metadata => Object

Additional metadata tags from the documentation.

See Also

• SleepingKingStudios::Docs::Data::Metadata

#name => String

The full, qualified name of the constant.

Returns

• (String) — the qualified name.

#parent_path => String

The path to the defining class or module’s data file.

Returns

• (String) — the file path.

#short_description => String

A short description of the constant.

The first part of the constant description, separated by the first paragraph break. Typically should fit on a single line of text.

Returns

• (String) — the short description.

See Also

• #description

#slug => String

The name of the constant in url-safe format.

Returns

• (String) — the constant name.

#value => String

A String representation of the value of the constant.

Returns

• (String) — the constant value.

Back To Top

---

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