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/main/server.rb

@@ -17,19 +17,34 @@ module BeEF
 module API
 module Server
 
+    # @note Defined API Paths
     API_PATHS = {
         'mount_handler' => :mount_handler,
         'pre_http_start' => :pre_http_start
     }
     
+    # Fires just before the HTTP Server is started
+    # @param [Object] http_hook_server HTTP Server object
     def pre_http_start(http_hook_server); end
     
+    # Fires just after handlers have been mounted
+    # @param [Object] server HTTP Server object
     def mount_handler(server); end
     
+    # Mounts a handler
+    # @param [String] url URL to be mounted
+    # @param [Boolean] hard whether or not it is a hard mount
+    # @param [Class] http_handler_class the handler Class
+    # @param [Array] args an array of arguments
+    # @note This is a direct API call and does not have to be registered to be used
     def self.mount(url, hard, http_handler_class, args = nil)
       BeEF::Core::Server.instance.mount(url, hard, http_handler_class, *args)
     end
 
+    # Unmounts a handler
+    # @param [String] url URL to be unmounted
+    # @param [Boolean] hard whether or not it is a hard mount
+    # @note This is a direct API call and does not have to be registered to be used
     def self.unmount(url, hard)
         BeEF::Core::Server.instance.unmount(url, hard)
     end