Class: SleepingKingStudios::Docs::Commands::Generators::ReferenceGenerator

Parent Namespace

SleepingKingStudios::Docs::Commands::Generators

Inherited Classes

SleepingKingStudios::Docs::Commands::Generators::Base > Cuprum::Command > Object

Defined In

lib/sleeping_king_studios/docs/commands/generators/reference_generator.rb

Table Of Contents

• Overview
• Constructor
• Instance Attributes
  • docs_path
  • options
• Instance Methods
  • dry_run?
  • file_path
  • force?
  • initialize
  • template_path
  • verbose?
  • version

Overview

Generator for writing reference files.

Back To Top

Constructor

#initialize(docs_path:, **options) => Base

Inherited From

SleepingKingStudios::Docs::Commands::Generators::Base

Parameters

• docs_path (String) — the directory path for generating the documentation files.
• options (Hash) — the configured options for the generator.

Options Hash (options)

• dry_run (Boolean) — if true, does not make any changes to the filesystem.
• force (Boolean) — if true, overwrites any existing files.
• version (String) — the code version for the generated documentation.
• verbose (Boolean) — if true, prints status messages to STDOUT.

Returns

• (Base) — a new instance of Base

Back To Top

Instance Attributes

#docs_path => String (readonly)

Inherited From

SleepingKingStudios::Docs::Commands::Generators::Base

Returns

• (String) — the directory path for generating the documentation files.

#options => Hash (readonly)

Inherited From

SleepingKingStudios::Docs::Commands::Generators::Base

Returns

• (Hash) — the configured options for the generator.

Back To Top

Instance Methods

#dry_run? => Boolean

Inherited From

SleepingKingStudios::Docs::Commands::Generators::Base

Returns

• (Boolean) — if true, does not make any changes to the filesystem.

#file_path(data_object:) => String

Determines the generated file path for the given data object.

Parameters

• data_object (SleepingKingStudios::Docs::Data::Base) — the data object for which the file is generated.

Returns

• (String) — the qualified path to the generated file.

#force? => Boolean

Inherited From

SleepingKingStudios::Docs::Commands::Generators::Base

Returns

• (Boolean) — if true, overwrites any existing files.

#template_path => String

Inherited From

SleepingKingStudios::Docs::Commands::Generators::Base

Returns

• (String) — the relative path to the Jekyll templates for each data type.

#verbose? => Boolean

Inherited From

SleepingKingStudios::Docs::Commands::Generators::Base

Returns

• (Boolean) — if true, prints status messages to STDOUT.

#version => String

Inherited From

SleepingKingStudios::Docs::Commands::Generators::Base

Returns

• (String) — the code version for the generated documentation.

Back To Top

---

Back to Documentation | Reference | SleepingKingStudios | SleepingKingStudios::Docs | SleepingKingStudios::Docs::Commands | SleepingKingStudios::Docs::Commands::Generators