summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJérémy Zurcher <jeremy@asynk.ch>2012-06-27 09:44:18 +0200
committerJérémy Zurcher <jeremy@asynk.ch>2012-06-27 09:44:18 +0200
commit4561c0f5fb01f06ed55b89c21c4c98813786abe8 (patch)
tree1be641acfbdae19872d1abd7c02213a6eb18f15c
parent0af512c674161ece0f757edda6bd09e9e4280d61 (diff)
downloadedoors-ruby-4561c0f5fb01f06ed55b89c21c4c98813786abe8.zip
edoors-ruby-4561c0f5fb01f06ed55b89c21c4c98813786abe8.tar.gz
small documentation updates
-rw-r--r--lib/edoors/door.rb6
-rw-r--r--lib/edoors/particle.rb2
-rw-r--r--lib/edoors/room.rb2
3 files changed, 5 insertions, 5 deletions
diff --git a/lib/edoors/door.rb b/lib/edoors/door.rb
index 553cb88..beb42ab 100644
--- a/lib/edoors/door.rb
+++ b/lib/edoors/door.rb
@@ -86,7 +86,7 @@ module Edoors
#
# process the given particle then forward it to user code
#
- # @param [Particle] p the Particle to be forwarded to user code
+ # @param [Particle] p the Particle to be processed
#
def process_p p
@viewer.receive_p p if @viewer
@@ -121,7 +121,7 @@ module Edoors
end
private :_send
#
- # send the given Particle to the user fifo
+ # send the given Particle to the application Particle fifo
#
# @param [Particle] p the Particle to be sent
# @param [String] a the post action
@@ -133,7 +133,7 @@ module Edoors
_send p, false, a, d
end
#
- # send the given Particle to the system fifo
+ # send the given Particle to the system Particle fifo
#
# @param [Particle] p the Particle to be sent
# @param [String] a the post action
diff --git a/lib/edoors/particle.rb b/lib/edoors/particle.rb
index c7244d0..cf262bf 100644
--- a/lib/edoors/particle.rb
+++ b/lib/edoors/particle.rb
@@ -29,7 +29,7 @@ module Edoors
# @param [Hash] o a customizable set of options
#
# @option o 'ts' [String]
- # Creation time
+ # creation time
# @option o 'src' [String]
# Iota where it's originated from
# @option o 'dst' [String]
diff --git a/lib/edoors/room.rb b/lib/edoors/room.rb
index 2c70935..decdb83 100644
--- a/lib/edoors/room.rb
+++ b/lib/edoors/room.rb
@@ -222,7 +222,7 @@ module Edoors
end
private :_send
#
- # send the given Particle to user Particle fifo
+ # send the given Particle to application Particle fifo
#
# @param [Particle] p the Particle to send
#