lib/fmod.rb in fmod-0.9.0 vs lib/fmod.rb in fmod-0.9.1

@@ -1,10 +1,13 @@
 
 require 'fiddle'
 require 'fiddle/import'
 require 'rbconfig'
 
+##
+# Top-level namespace containing the entirety of the FMOD API.
+# @author Eric "ForeverZer0" Freed
 module FMOD
 
   include Fiddle
 
   ##
@@ -428,10 +431,10 @@
   ##
   # Invokes the specified native function.
   #
   # @param function [Symbol] Symbol name of an FMOD function, without the the
   #   leading "FMOD_" prefix.
-  # @raise [Error] if the result code returned by FMOD is not {Result::OK}.
+  # @raise [Error] if the result code returned by FMOD is not 0.
   # @return [void]
   # @see invoke_protect
   def self.invoke(function, *args)
     result = @functions[function].call(*args)
     raise Error, result unless result.zero?