Module: Yard::Lint::Validators::Documentation::MissingReturn

Defined in:

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

Overview

MissingReturn validator

Ensures that all methods have an explicit ‘@return` tag documented. This validator helps maintain consistent API documentation by catching methods that are missing return value documentation. This validator is disabled by default and must be explicitly enabled in configuration.

## Configuration

This validator is disabled by default. To enable it:

Documentation/MissingReturn:
  Enabled: true
  Severity: warning
  ExcludedMethods:
    - initialize
    - '/^_/'  # Exclude private methods starting with underscore

### ExcludedMethods

Supports three pattern types:

• Simple name: ‘initialize’ - matches all methods with that name

• Arity notation: ‘initialize/0’ - matches only methods with specific parameter count

• Regex pattern: ‘/^_/’ - matches methods using regular expressions

Examples:

Bad - Missing @return tag

# Calculates the total price
def calculate_total
  @items.sum(&:price)
end

Good - Return value documented

# Calculates the total price
# @return [Float] the total price of all items
def calculate_total
  @items.sum(&:price)
end

Defined Under Namespace

Classes: Config, MessagesBuilder, Parser, Result, Validator