lib/knj/errors.rb in knjrbfw-0.0.29 vs lib/knj/errors.rb in knjrbfw-0.0.30

@@ -1,12 +1,21 @@
+#This module contains various extra errors used by the other Knj-code.
 module Knj::Errors
   class Notice < StandardError; end
   class NotFound < StandardError; end
   class InvalidData < StandardError; end
   class Retry < StandardError; end
   class NoAccess < StandardError; end
   class Exists < StandardError; end
   
+  #Returns a string describing the given error. Possible arguments can be given if you want the returned string formatted as HTML.
+  #
+  #===Examples
+  # begin
+  #   raise 'test'
+  # rescue => e
+  #   print Knj::Errors.error_str(e, :html => true)
+  # end
   def self.error_str(err, args = {})
     if !err.is_a?(Exception) and err.class.message != "Java::JavaLang::LinkageError"
       raise "Invalid object of class '#{err.class.name}' given."
     end
     
\ No newline at end of file