static.rb in ronin-0.3.0

- old
+ new

@@ -1,9 +1,7 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,31 +14,42 @@
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
 #
 
 require 'set'
 
 module Ronin
   module Static
     #
-    # The Set of directories which contain static content.
+    # @return [Set]
+    #   The directories which contain static content.
     #
     def Static.static_dirs
       @@ronin_static_dirs ||= Set[]
     end
 
     #
-    # Adds the specified _path_ to the Set of static directories.
+    # Adds the path to the Set of static directories.
     #
+    # @param [String] path
+    #   The path to add to +static_dirs+.
+    #
+    # @return [String]
+    #   The fully qualified form of the specified _path_.
+    #
+    # @example
+    #   Static.directory(File.join(File.dirname(__FILE__),'..','..','..','static'))
+    #
+    # @raise [RuntimeError] The specified _path_ is not a directory.
+    #
     def Static.directory(path)
       path = File.expand_path(path)
 
       unless File.directory?(path)
-        raise("#{path.dump} must be a directory")
+        raise(RuntimeError,"#{path.dump} must be a directory")
       end
 
       Static.static_dirs << path
       return path
     end