Class: Yard::Lint::Validators::Documentation::OrphanedDocComment::Result

Inherits:

Results::Base

• Object
• Results::Base
• Yard::Lint::Validators::Documentation::OrphanedDocComment::Result

Defined in:

lib/yard/lint/validators/documentation/orphaned_doc_comment/result.rb

Overview

Result object for orphaned documentation comment offenses

Instance Attribute Summary

Attributes inherited from Results::Base

#config, #offenses

Instance Method Summary

• #build_message(offense) ⇒ String

  Formatted message.

Methods inherited from Results::Base

#count, #each, #empty?, #initialize, #map, #validator_name

Constructor Details

This class inherits a constructor from Yard::Lint::Results::Base

Instance Method Details

#build_message(offense) ⇒ String

Returns formatted message.

Parameters:

• offense (Hash) —

  offense data

Returns:

• (String) —

  formatted message

# File 'lib/yard/lint/validators/documentation/orphaned_doc_comment/result.rb', line 16

def build_message(offense)
  MessagesBuilder.call(offense)
end