unimidi 0.0.8-i686-linux → 0.1.0-i686-linux

data/lib/unimidi/adapter/alsa-rawmidi.rb

@@ -1,3 +1,8 @@
+#!/usr/bin/env ruby
+#
+# (c)2010-2011 Ari Russo and licensed under the Apache 2.0 License
+#
+
 require 'alsa-rawmidi'
 
 module UniMIDI

data/lib/unimidi/adapter/midi-jruby.rb

@@ -1,3 +1,8 @@
+#!/usr/bin/env ruby
+#
+# (c)2010-2011 Ari Russo and licensed under the Apache 2.0 License
+#
+
 require 'midi-jruby'
 
 module UniMIDI

data/lib/unimidi/adapter/midi-winmm.rb

@@ -1,3 +1,8 @@
+#!/usr/bin/env ruby
+#
+# (c)2010-2011 Ari Russo and licensed under the Apache 2.0 License
+#
+
 require 'midi-winmm'
 
 module UniMIDI

data/lib/unimidi/congruous_api_adapter.rb

@@ -1,3 +1,8 @@
+#!/usr/bin/env ruby
+#
+# (c)2010-2011 Ari Russo and licensed under the Apache 2.0 License
+#
+
 module UniMIDI
 
   module CongruousApiAdapter
@@ -10,6 +15,7 @@ module UniMIDI
         @name = @device.name
       end
       
+      # enable the device for use, can be passed a block to which the device will be passed back
       def open(*a, &block)
         begin
           @device.open(*a)
@@ -19,6 +25,7 @@ module UniMIDI
         end
       end
       
+      # close the device
       def close(*a)
         @device.close(*a)
       end
@@ -130,6 +137,7 @@ module UniMIDI
       
       module ClassMethods
              
+        # returns all inputs
         def all
           device_class.all.map { |d| new(d) }
         end
@@ -145,16 +153,31 @@ module UniMIDI
         base.extend(ClassMethods)
       end
       
+      # sends a message to the output. the message can be:
+      #
+      # bytes eg output.puts(0x90, 0x40, 0x40) 
+      # an array of bytes eg output.puts([0x90, 0x40, 0x40])
+      # or a string eg output.puts("904040")
+      #
       def puts(*a)
         @device.puts(*a)
       end
       
+      # sends a message to the output in a form of a string eg "904040".  this method does not do
+      # type checking and therefore is more performant than puts
       def puts_bytestr(*a)
         @device.puts_bytestr(*a)
       end
+
+      # sends a message to the output in a form of bytes eg output.puts_bytes(0x90, 0x40, 0x40).  
+      # this method does not do type checking and therefore is more performant than puts      
+      def puts_bytes(*a)
+        @device.puts_bytes(*a)
+      end
       
       module ClassMethods
         
+        # returns all outputs
         def all
           device_class.all.map { |d| new(d) }
         end

data/lib/unimidi/platform.rb

@@ -1,3 +1,8 @@
+#!/usr/bin/env ruby
+#
+# (c)2010-2011 Ari Russo and licensed under the Apache 2.0 License
+#
+
 require 'singleton'
 
 module UniMIDI

data/lib/unimidi.rb

@@ -1,10 +1,12 @@
 #!/usr/bin/env ruby
 #
 # A realtime MIDI interface for Ruby
+# (c)2010-2011 Ari Russo and licensed under the Apache 2.0 License
 #
+
 module UniMIDI
   
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
  
 end
 

metadata

@@ -2,7 +2,7 @@
 name: unimidi
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.8
+  version: 0.1.0
 platform: i686-linux
 authors: 
 - Ari Russo