Class: PlatformosCheck::PlatformosLiquid::SourceIndex::ParameterEntry

Inherits:
BaseEntry
  • Object
show all
Defined in:
lib/platformos_check/platformos_liquid/source_index/parameter_entry.rb

Constant Summary

Constants inherited from BaseEntry

BaseEntry::PLATFORMOS_DOCUMENTATION_URL

Instance Attribute Summary

Attributes inherited from BaseEntry

#hash, #return_type

Instance Method Summary collapse

Methods inherited from BaseEntry

#deprecated?, #deprecation_reason, #description, #initialize, #name, #return_type_instance

Constructor Details

This class inherits a constructor from PlatformosCheck::PlatformosLiquid::SourceIndex::BaseEntry

Instance Method Details

#full_summary ⇒ Object 



15
16
17
 
# File 'lib/platformos_check/platformos_liquid/source_index/parameter_entry.rb', line 15

def full_summary
  "#{hash['name']} - #{hash['description']}"
end

#platformos_documentation_url ⇒ Object 



11
12
13
 
# File 'lib/platformos_check/platformos_liquid/source_index/parameter_entry.rb', line 11

def platformos_documentation_url
  "#{PLATFORMOS_DOCUMENTATION_URL}/api-reference/liquid/filters/#{hash['name']}"
end

#summary ⇒ Object 



7
8
9
 
# File 'lib/platformos_check/platformos_liquid/source_index/parameter_entry.rb', line 7

def summary
  nil
end