class YARD::CodeObjects::Chef::RecipeObject
A RecipeObject
represents a recipe in a chef cookbook. See docs.opscode.com/essentials_cookbook_recipes.html
Public Class Methods
new(namespace, name)
click to toggle source
Creates a new instance of RecipeObject
.
@param namespace [NamespaceObject] namespace to which the recipe belongs @param name [String] name of the recipe
@return [RecipeObject] the newly created RecipeObject
Calls superclass method
YARD::CodeObjects::Chef::ChefObject::new
# File lib/yard-chef/code_objects/recipe_object.rb, line 39 def initialize(namespace, name) super(namespace, name) @short_desc = '' end
Public Instance Methods
name()
click to toggle source
Prefixes recipe name with the name of the cookbook.
@return [String] recipe name
# File lib/yard-chef/code_objects/recipe_object.rb, line 48 def name parent.name.to_s << '::' << @name.to_s end