Module: Yard::Lint::Validators::Documentation::UndocumentedOptions

Defined in:

lib/yard/lint/validators/documentation/undocumented_options.rb,
lib/yard/lint/validators/documentation/undocumented_options/config.rb,
lib/yard/lint/validators/documentation/undocumented_options/parser.rb,
lib/yard/lint/validators/documentation/undocumented_options/result.rb,
lib/yard/lint/validators/documentation/undocumented_options/validator.rb

Overview

UndocumentedOptions validator

Checks that options hashes have detailed documentation about their keys. When a method accepts an options hash parameter, the individual option keys should be documented using @option tags. This validator is enabled by default.

Configuration

To disable this validator:

Documentation/UndocumentedOptions:
  Enabled: false

Examples:

Bad - Options parameter without @option tags

# Configures the service
# @param options [Hash] configuration options
def configure(options)
end

Good - Options keys documented with @option tags

# Configures the service
# @param options [Hash] configuration options
# @option options [Boolean] :enabled Whether to enable the feature
# @option options [Integer] :timeout Connection timeout in seconds
def configure(options)
end

Defined Under Namespace

Classes: Config, Parser, Result, Validator