[macruby-changes] [3305] MacRuby/trunk/gcd_prelude.rb

[source_changes at macosforge.org]

Revision: 3305
          http://trac.macosforge.org/projects/ruby/changeset/3305
Author:   ernest.prabhakar at gmail.com
Date:     2010-01-19 15:56:53 -0800 (Tue, 19 Jan 2010)
Log Message:
-----------
Add gcd_prelude rdoc

Modified Paths:
--------------
    MacRuby/trunk/gcd_prelude.rb

Modified: MacRuby/trunk/gcd_prelude.rb
===================================================================
--- MacRuby/trunk/gcd_prelude.rb	2010-01-19 23:56:52 UTC (rev 3304)
+++ MacRuby/trunk/gcd_prelude.rb	2010-01-19 23:56:53 UTC (rev 3305)
@@ -32,32 +32,41 @@
   end
   
   class Queue
+    # Returns a Dispatch::Source::DATA_ADD
     def on_add(&block)
       Dispatch::Source.new(Dispatch::Source::DATA_ADD, 0, 0, self, &block)
     end
 
+    # Returns a Dispatch::Source::DATA_OR
     def on_or(&block)
       Dispatch::Source.new(Dispatch::Source::DATA_OR, 0, 0, self, &block)
     end
 
+    # Takes event symbols: :delete, :write, :extend, :attrib, :link, :rename, :revoke
+    # Returns a Dispatch::Source::PROC
     def on_process_event(pid, *events, &block)
       mask = events.collect {|e| Dispatch::Source::proc_event(e)}.reduce(:|)
       Dispatch::Source.new(Dispatch::Source::PROC, pid, mask, self, &block)
     end
 
+    # Returns a Dispatch::Source::SIGNAL
     def on_signal(signal, &block)
       signal = Signal.list[signal.to_s] if signal.to_i == 0
       Dispatch::Source.new(Dispatch::Source::SIGNAL, signal, 0, self, &block)
     end
 
+    # Returns a Dispatch::Source::READ
     def on_read(file, &block)
       Dispatch::Source.new(Dispatch::Source::READ, file, 0, self, &block)
     end
 
+    # Returns a Dispatch::Source::WRITE
     def on_write(file, &block)
       Dispatch::Source.new(Dispatch::Source::WRITE, file, 0, self, &block)
     end
 
+    # Takes event symbols: :exit, :fork, :exec, :signal
+    # Returns a Dispatch::Source::VNODE
     def on_file_event(file, *events, &block)
       mask = events.collect {|e| Dispatch::Source::vnode_event(e)}.reduce(:|)
       Dispatch::Source.new(Dispatch::Source::VNODE, file,mask, self,&block)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macruby-changes/attachments/20100119/eac1c85a/attachment.html>