Module: Yard::Lint::Validators::Warnings::UnknownParameterName

Defined in:

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

Overview

UnknownParameterName validator

Detects @param tags that document parameters which don't exist in the method signature. This often occurs after refactoring when parameter names change but documentation isn't updated. This validator is enabled by default.

Configuration

To disable this validator:

Warnings/UnknownParameterName:
  Enabled: false

Examples:

Bad - @param documents non-existent parameter

# @param old_name [String] this parameter doesn't exist anymore
def process(new_name)
end

Good - @param matches actual parameters

# @param new_name [String] the name to process
def process(new_name)
end

Defined Under Namespace

Classes: Config, MessagesBuilder, Parser, Result, Validator