Class: Yard::Lint::Validators::Documentation::UndocumentedObjects::MessagesBuilder

Inherits:

Object

• Object
• Yard::Lint::Validators::Documentation::UndocumentedObjects::MessagesBuilder

Defined in:

lib/yard/lint/validators/documentation/undocumented_objects/messages_builder.rb

Overview

Builds messages for undocumented objects offenses

Class Method Summary

• .call(offense) ⇒ String

  Build message for an undocumented object.

Class Method Details

.call(offense) ⇒ String

Build message for an undocumented object

Parameters:

• offense (Hash) —

  offense data with :element key

Returns:

• (String) —

  formatted message

# File 'lib/yard/lint/validators/documentation/undocumented_objects/messages_builder.rb', line 14

def call(offense)
  "Documentation required for `#{offense[:element]}`"
end