@@ -11,7 +11,7 @@ module DataModels
1111 # @param [String] data A data object
1212 # @param [Integer] cid A remote counter id
1313 #
14- # @return [Hash] An acknowledgement object
14+ # @return An acknowledgement object
1515 #
1616 def get_ack_object ( error , data , cid )
1717 OpenStruct . new (
@@ -21,12 +21,12 @@ def get_ack_object(error, data, cid)
2121 ) . to_h
2222 end
2323
24- # Returns data model for an emitter event
24+ # Returns a data model for an emitter event
2525 #
2626 # @param [String] event An emit event
27- # @param [Hash] object The data to be sent
27+ # @param [Hash] object A data object
2828 #
29- # @return [Hash] An emit object
29+ # @return An emit object
3030 #
3131 def get_emit_object ( event , object )
3232 OpenStruct . new (
@@ -35,13 +35,13 @@ def get_emit_object(event, object)
3535 ) . to_h
3636 end
3737
38- # Returns data model for emitter acknowledgment event
38+ # Returns a data model for an emitter acknowledgment event
3939 #
4040 # @param [String] event An emitter acknowledgment event
41- # @param [Hash] object The data to be sent
42- # @param [Integer] counter A counter
41+ # @param [Hash] object A data object
42+ # @param [Integer] counter A counter for a particular event
4343 #
44- # @return [Hash] An emitter acknowledgment object
44+ # @return An emitter acknowledgment object
4545 #
4646 def get_emit_ack_object ( event , object , counter )
4747 OpenStruct . new (
@@ -51,11 +51,11 @@ def get_emit_ack_object(event, object, counter)
5151 ) . to_h
5252 end
5353
54- # Returns data model for handshake event
54+ # Returns a data model for a handshake event
5555 #
56- # @param [Integer] counter A counter for event
56+ # @param [Integer] counter A counter for a particular event
5757 #
58- # @return [Hash] A handshake object
58+ # @return A handshake object
5959 #
6060 def get_handshake_object ( counter )
6161 OpenStruct . new (
@@ -67,13 +67,13 @@ def get_handshake_object(counter)
6767 ) . to_h
6868 end
6969
70- # Returns data model for publish and publish with acknowledgment event
70+ # Returns a data model for publish and publish with acknowledgment event
7171 #
72- # @param [String] channel A channel where data should be published
73- # @param [String] data The data to be published
74- # @param [Integer] counter A counter for event
72+ # @param [String] channel A channel for publishing data
73+ # @param [String] data A data object
74+ # @param [Integer] counter A counter for a particular event
7575 #
76- # @return [Hash] A publisher object
76+ # @return A publisher object
7777 #
7878 def get_publisher_object ( channel , data , counter )
7979 OpenStruct . new (
@@ -86,12 +86,12 @@ def get_publisher_object(channel, data, counter)
8686 ) . to_h
8787 end
8888
89- # Returns data model for subscribe and subscribe with acknowledgment event
89+ # Returns a data model for subscribe and subscribe with acknowledgment event
9090 #
9191 # @param [String] channel A channel to subscribe
92- # @param [Integer] counter A counter for event
92+ # @param [Integer] counter A counter for a particular event
9393 #
94- # @return [Hash] A subscribe object
94+ # @return A subscribe object
9595 #
9696 def get_subscribe_object ( channel , counter )
9797 OpenStruct . new (
@@ -103,12 +103,12 @@ def get_subscribe_object(channel, counter)
103103 ) . to_h
104104 end
105105
106- # Returns data model for unsubscribe and unsubscribe with acknowledgment event
106+ # Returns a data model for unsubscribe and unsubscribe with acknowledgment event
107107 #
108108 # @param [String] channel A channel to unsubscribe
109- # @param [Integer] counter A counter for event
109+ # @param [Integer] counter A counter for a particular event
110110 #
111- # @return [Hash] A unsubscribe object
111+ # @return An unsubscribe object
112112 #
113113 def get_unsubscribe_object ( channel , counter )
114114 OpenStruct . new (
0 commit comments