Class: YARD::CodeObjects::Chef::RecipeObject

Inherits:

ChefObject

• Object
• NamespaceObject
• ChefObject
• YARD::CodeObjects::Chef::RecipeObject

Defined in:

lib/yard-chefdoc/code_objects/recipe.rb

Instance Attribute Summary

Attributes inherited from ChefObject

#file, #header

Instance Method Summary

• #initialize(namespace, name) ⇒ RecipeObject constructor

  Creates a new instance of RecipeObject.

• #line ⇒ Integer

  Needed by the template to render recipe source code.

Methods inherited from ChefObject

#chef_init, #children_by_type, #find_description_in, #find_header_in, register, register_element

Constructor Details

#initialize(namespace, name) ⇒ RecipeObject

Creates a new instance of RecipeObject.

Parameters:

• namespace (NamespaceObject) —

  namespace to which the recipe belongs

• name (String) —

  name of the recipe

# File 'lib/yard-chefdoc/code_objects/recipe.rb', line 15

def initialize(namespace, name)
  super(namespace, name)
end

Instance Method Details

#line ⇒ Integer

Needed by the template to render recipe source code. Since we always display the full source we start with 1

Returns:

• (Integer) —

  1

# File 'lib/yard-chefdoc/code_objects/recipe.rb', line 24

def line
  1
end