Class: SleepingKingStudios::Docs::Commands::Generate

Inherits:
SleepingKingStudios::Docs::Commands::Generators::Base show all
Defined in:
lib/sleeping_king_studios/docs/commands/generate.rb

Overview

Generates YARD documentation files.

Instance Attribute Summary

Attributes inherited from SleepingKingStudios::Docs::Commands::Generators::Base

#docs_path, #options

Instance Method Summary collapse

Methods inherited from SleepingKingStudios::Docs::Commands::Generators::Base

#dry_run?, #force?, #template_path, #verbose?, #version

Constructor Details

#initialize(docs_path: , **options) ⇒ Generate

Returns a new instance of Generate.

Parameters:

  • docs_path (String) (defaults to: ) —

    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.



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/sleeping_king_studios/docs/commands/generate.rb', line 23

def initialize(
  docs_path:,
  error_stream:  $stderr,
  output_stream: $stdout,
  **options
)
  super(docs_path:, **options)

  @error_stream  = error_stream
  @output_stream = output_stream
end