Class: SleepingKingStudios::Docs::Errors::OutdatedDocumentation

Parent Namespace

SleepingKingStudios::Docs::Errors

Inherited Classes

Cuprum::Error > Object

Defined In

lib/sleeping_king_studios/docs/errors/outdated_documentation.rb

Table Of Contents

• Overview
• Constants
  • TYPE
• Constructor
• Instance Attributes
  • changed_files
  • docs_path
  • extra_files
  • missing_files
  • version
• Instance Methods
  • initialize

Overview

Error returned when the checked documentation does not match the code.

Back To Top

Constants

TYPE

= 'sleeping_king_studios.docs.errors.outdated_documentation'

Short string used to identify the type of error.

Back To Top

Constructor

#initialize(docs_path:, changed_files: [], extra_files: [], missing_files: [], version: nil) => OutdatedDocumentation

Parameters

• docs_path (String) — the path to the generated documentation.
• version (String, nil) — the version of the generated documentation.
• changed_files (Array<String>) — the list of docs files with missing or non-matching checksums.
• extra_files (Array<String>) — the list of additional files in the docs directory.
• missing_files (Array<String>) — the list of missing docs files based on the registered code.

Returns

• (OutdatedDocumentation) — a new instance of OutdatedDocumentation

Back To Top

Instance Attributes

#changed_files => Array<String> (readonly)

Returns

• (Array<String>) — the list of docs files with missing or non-matching checksums.

#docs_path => String (readonly)

Returns

• (String) — the path to the generated documentation.

#extra_files => Array<String> (readonly)

Returns

• (Array<String>) — the list of additional files in the docs directory.

#missing_files => Array<String> (readonly)

Returns

• (Array<String>) — the list of missing docs files based on the registered code.

#version => String, nil (readonly)

Returns

• (String, nil) — the version of the generated documentation.

Back To Top

Instance Methods

Back To Top

---

Back to Documentation | Reference | SleepingKingStudios | SleepingKingStudios::Docs | SleepingKingStudios::Docs::Errors