ChefObject
A CookbookObject represents a Chef cookbook. See wiki.opscode.com/display/chef/Cookbooks for more information about cookbook.
Lightweight providers implemented in the cookbook.
@return [Array<ProviderObject>] lightweight providers in the cookbook
Lightweight resources implemented in the cookbook.
@return [Array<ResourceObject>] lightweight resources in the cookbook
Short description for the cookbook.
@param short_desc [String] short description for the cookbook
@return [String] short description for the cookbook
Creates a new CookbookObject instance. @param namespace [NamespaceObject] namespace to which the cookbook belongs @param name [String] name of the cookbook
@return [CookbookObject] the newly created CookbookObject
# File lib/yard-chef/code_objects/cookbook_object.rb, line 68 def initialize(namespace, name) super(namespace, name) @resources = [] @providers = [] @libraries = [] end
Attributes implemented in the cookbook.
@return [Array<AttributeObject>] attributes in the cookbook
# File lib/yard-chef/code_objects/cookbook_object.rb, line 87 def attributes children_by_type(:attribute) end
Definitions implemented in the cookbook.
@return [Array<MethodObject>] definitions in the cookbook
# File lib/yard-chef/code_objects/cookbook_object.rb, line 95 def definitions children_by_type(:method) end
Libraries defined in the cookbook.
@return [Array<ModuleObject>] libraries in the cookbook
# File lib/yard-chef/code_objects/cookbook_object.rb, line 103 def libraries modules = YARD::Registry.all(:module) modules.select { |lib| !lib.parent.root? && lib.file =~ /#{@name}/ } end
Generated with the Darkfish Rdoc Generator 2.