Module: Yard::Lint::Validators::Warnings::UnknownDirective

Defined in:

lib/yard/lint/validators/warnings/unknown_directive.rb,
lib/yard/lint/validators/warnings/unknown_directive/config.rb,
lib/yard/lint/validators/warnings/unknown_directive/parser.rb,
lib/yard/lint/validators/warnings/unknown_directive/result.rb,
lib/yard/lint/validators/warnings/unknown_directive/validator.rb

Overview

UnknownDirective validator

Detects usage of unrecognized YARD directives in documentation. Directives are special YARD commands (like @!attribute, @!method) that control documentation generation. This validator flags unknown directives that could indicate errors. This validator is enabled by default.

Configuration

To disable this validator:

Warnings/UnknownDirective:
  Enabled: false

Examples:

Bad - Unknown or misspelled directive

# @!attribute [r] name
# @!method foo
class User
end

Good - Standard YARD directives

# @!attribute [r] name
# @!method foo
class User
end

Defined Under Namespace

Classes: Config, Parser, Result, Validator