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

Parent Namespace

SleepingKingStudios::Docs::Commands::Generators

Inherited Classes

Cuprum::Command > Object

Included Modules

Cuprum::ExceptionHandling

Defined In

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

Table Of Contents

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

Overview

Abstract base class for writing generator classes.

Back To Top

Direct Subclasses

SleepingKingStudios::Docs::Commands::Generate, SleepingKingStudios::Docs::Commands::Generators::DataGenerator, SleepingKingStudios::Docs::Commands::Generators::ReferenceGenerator

Back To Top

Constructor

#initialize(docs_path:, **options) => 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)

Returns

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

#options => Hash (readonly)

Returns

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

Back To Top

Instance Methods

#dry_run? => Boolean

Returns

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

#force? => Boolean

Returns

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

#template_path => String

Returns

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

#verbose? => Boolean

Returns

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

#version => String

Returns

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

Back To Top

---

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