Adding documentation

Author: adamhjk

chef/lib/chef/client.rb

@@ -94,7 +94,7 @@ def run_solo
     # node_name<String>:: The name of the node to build - defaults to nil
     #
     # === Returns
-    # node:: Returns the created node object, also stored in @node
+    # node<Chef::Node>:: Returns the created node object, also stored in @node
     def build_node(node_name=nil)
       node_name ||= Facter["fqdn"].value ? Facter["fqdn"].value : Facter["hostname"].value
       @safe_name = node_name.gsub(/\./, '_')

chef/lib/chef/compile.rb

@@ -22,6 +22,9 @@ class Compile
 
     # Creates a new Chef::Compile object.  This object gets used by the Chef Server to generate
     # a fully compiled recipe list for a node.
+    #
+    # === Returns
+    # object<Chef::Compile>:: Duh. :)
     def initialize()
       @node = nil
       @cookbook_loader = Chef::CookbookLoader.new
@@ -35,7 +38,7 @@ def initialize()
     # The first step in compiling the catalog. Results available via the node accessor.
     #
     # === Returns
-    # <Chef::Node>:: The loaded Chef Node
+    # node<Chef::Node>:: The loaded Chef Node
     def load_node(name)
       Chef::Log.debug("Loading Chef Node #{name} from CouchDB")
       @node = Chef::Node.load(name)

chef/lib/chef/cookbook.rb

@@ -22,6 +22,10 @@ class Cookbook
                   :lib_files, :name
     attr_reader :recipe_files
 
+    # Creates a new Chef::Cookbook object.  
+    #
+    # === Returns
+    # object<Chef::Cookbook>:: Duh. :)
     def initialize(name)
       @name = name
       @attribute_files = Array.new
@@ -33,13 +37,28 @@ def initialize(name)
       @lib_files = Array.new
     end
 
+    # Loads all the library files in this cookbook via require.
+    #
+    # === Returns
+    # true:: Always returns true
     def load_libraries
       @lib_files.each do |file|
         Chef::Log.debug("Loading cookbook #{name} library file: #{file}")
         require file
       end
+      true
     end
 
+    # Loads all the attribute files in this cookbook within a particular <Chef::Node>.
+    #
+    # === Parameters
+    # node<Chef::Node>:: The Chef::Node to apply the attributes to
+    #
+    # === Returns
+    # node<Chef::Node>:: The updated Chef::Node object
+    #
+    # === Raises
+    # <ArgumentError>:: If the argument is not a kind_of? <Chef::Node>
     def load_attributes(node)
       unless node.kind_of?(Chef::Node)
         raise ArgumentError, "You must pass a Chef::Node to load_attributes!"
@@ -51,6 +70,10 @@ def load_attributes(node)
       node
     end
 
+    # Loads all the resource definitions in this cookbook.
+    #
+    # === Returns
+    # definitions<Hash>: A hash of <Chef::ResourceDefinition> objects, keyed by name.
     def load_definitions
       results = Hash.new
       @definition_files.each do |file|