Module: Yard::Lint::Validators::Warnings::InvalidDirectiveFormat

Defined in:

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

Overview

InvalidDirectiveFormat validator

Detects malformed YARD directive syntax. Directives have specific format requirements (like @!attribute [r] name for read-only attributes), and this validator ensures those requirements are met. This validator is enabled by default.

Configuration

To disable this validator:

Warnings/InvalidDirectiveFormat:
  Enabled: false

Examples:

Bad - Malformed directive syntax

# @!attribute name missing brackets
# @!method [r] foo wrong format for method
class User
end

Good - Correctly formatted directives

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

Defined Under Namespace

Classes: Config, Parser, Result, Validator