Yard commented 1/3 of codebase, more to come...

git-svn-id: https://beef.googlecode.com/svn/trunk@1274 b87d56ec-f9c0-11de-8c8a-61c5e9addfc9

core/api/module.rb

@@ -21,6 +21,7 @@ module API
 
   module Module
     
+    # @note Defined API Paths
     API_PATHS = {
         'pre_soft_load' => :pre_soft_load,
         'post_soft_load' => :post_soft_load,
@@ -30,16 +31,31 @@ module API
         'override_execute' => :override_execute
     }
     
+    # Fired before a module soft load
+    # @param [String] mod module key of module about to be soft loaded
     def pre_soft_load(mod); end
 
+    # Fired after module soft load
+    # @param [String] mod module key of module just after soft load
     def post_soft_load(mod); end
 
+    # Fired before a module hard load
+    # @param [String] mod module key of module about to be hard loaded
     def pre_hard_load(mod); end
 
+    # Fired after module hard load
+    # @param [String] mod module key of module just after hard load
     def post_hard_load(mod); end
 
+    # Fired before standard module options are returned
+    # @return [Hash] a hash of options
+    # @note the option hash is merged with all other API hook's returned hash. Hooking this API method prevents the default options being returned.
     def get_options; end
 
+    # Fired just before a module is executed
+    # @param [String] mod module key
+    # @param [Hash] opts a Hash of options   
+    # @note Hooking this API method stops the default flow of the Module.execute() method.
     def override_execute(mod, opts); end
 
   end