Class: SleepingKingStudios::Docs::Data::Metadata

Parent Namespace

SleepingKingStudios::Docs::Data

Inherited Classes

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

Defined In

lib/sleeping_king_studios/docs/data/metadata.rb

Table Of Contents

• Overview
  • See Also
• Constructor
• Instance Methods
  • abstract
  • api
  • as_json
  • authors
  • deprecated
  • examples
  • initialize
  • notes
  • see
  • since
  • todos
  • versions

Overview

Object representing the metadata tags for a Ruby module.

Each module can have the following metadata tags:

• @example
• @note
• @see
• @todo

Other tags are not currently supported.

See Also

• SleepingKingStudios::Docs::Data::ModuleObject
• SleepingKingStudios::Docs::Data::SeeTags

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

#abstract => String, nil

Returns the @abstract tag, if any, defined for the module.

Returns

• (String) — the contents of the @abstract tag, or an empty string if the tag does not have contents.
• (nil) — if there is no @abstract tag defined.

#api => String, nil

Returns the @api tag, if any, defined for the module.

Returns

• (String) — the contents of the @api tag.
• (nil) — if there is no @api tag defined.

#as_json => Hash{String => Object}

Generates a JSON-compatible representation of the metadata.

Returns a Hash with zero or more of the following keys:

• ‘examples’: An Array of Hashes with keys ‘name’ and ‘text’ and String values.
• ‘notes’: An Array of Strings.
• ‘see’: An Array of Hashes with String values.
• ‘todo’: An Array of Strings.

Returns

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

#authors => Array<String>

Collects the @author tags defined for the module.

Returns

• (Array<String>) — the collected authors.

#deprecated => String, nil

Returns the @deprecated tag, if any, defined for the module.

Returns

• (String) — the contents of the @deprecated tag, or an empty string if the tag does not have contents.
• (nil) — if there is no @deprecated tag defined.

#examples => Array<Hash{String => String}>

Collects the @example tags defined for the module.

Each @example tag is represented as a Hash with the following keys:

• ‘name’: The displayed name of the example. May be an empty String.
• ‘text’: The text for the example.

Returns

• (Array<Hash{String => String}>) — the collected examples.

#notes => Array<String>

Collects the @note tags defined for the module.

Returns

• (Array<String>) — the collected notes.

#see => Array<Hash{String => String}>

Collects the @see tags defined the for the module.

Each @see tag is represented as a Hash with String keys and values, and has at a minimum the ‘text’ key. See the SeeTag#as_json method for details.

Returns

• (Array<Hash{String => String}>)

#since => Array<String>

Collects the @since tags defined for the module.

Returns

• (Array<String>) — the collected @since tags.

#todos => Array<String>

Collects the @todo tags defined for the module.

Returns

• (Array<String>) — the collected todos.

#versions => Array<String>

Collects the @version tags defined for the module.

Returns

• (Array<String>) — the collected @version tags.

Back To Top

---

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