Class: Yard::Lint::Validators::Config

Inherits:

Object

• Object
• Yard::Lint::Validators::Config

Defined in:

lib/yard/lint/validators/config.rb

Overview

Base configuration class for validators Provides common class attributes for all validators

Direct Known Subclasses

Documentation::BlankLineBeforeDefinition::Config, Documentation::EmptyCommentLine::Config, Documentation::MarkdownSyntax::Config, Documentation::MissingReturn::Config, Documentation::UndocumentedBooleanMethods::Config, Documentation::UndocumentedMethodArguments::Config, Documentation::UndocumentedObjects::Config, Documentation::UndocumentedOptions::Config, Semantic::AbstractMethods::Config, Tags::ApiTags::Config, Tags::CollectionType::Config, Tags::ExampleStyle::Config, Tags::ExampleSyntax::Config, Tags::ForbiddenTags::Config, Tags::InformalNotation::Config, Tags::InvalidTypes::Config, Tags::MeaninglessTag::Config, Tags::NonAsciiType::Config, Tags::OptionTags::Config, Tags::Order::Config, Tags::RedundantParamDescription::Config, Tags::TagGroupSeparator::Config, Tags::TagTypePosition::Config, Tags::TypeSyntax::Config, Warnings::DuplicatedParameterName::Config, Warnings::InvalidDirectiveFormat::Config, Warnings::InvalidTagFormat::Config, Warnings::UnknownDirective::Config, Warnings::UnknownParameterName::Config, Warnings::UnknownTag::Config

Class Attribute Summary

• .combines_with ⇒ Array<String>

  Validators to combine with this one.

• .defaults ⇒ Hash

  Default configuration for this validator.

• .id ⇒ Symbol

  Unique identifier for this validator.

Class Attribute Details

.combines_with ⇒ Array<String>

Validators to combine with this one

Returns:

• (Array<String>) —

  validator names to combine, empty array for standalone

# File 'lib/yard/lint/validators/config.rb', line 20

def combines_with
  @combines_with ||= []
end

.defaults ⇒ Hash

Default configuration for this validator

Returns:

• (Hash) —

  default configuration hash

# File 'lib/yard/lint/validators/config.rb', line 16

def defaults
  @defaults
end

.id ⇒ Symbol

Unique identifier for this validator

Returns:

• (Symbol) —

  validator identifier

# File 'lib/yard/lint/validators/config.rb', line 12

def id
  @id
end