lib/onstomp/open-uri/client_extensions.rb in onstomp-1.0.0 vs lib/onstomp/open-uri/client_extensions.rb in onstomp-1.0.1
- old
+ new
@@ -3,11 +3,11 @@
# Mixin of extensions added to {OnStomp::Client clients} when they are
# created by opening a stomp:// URI.
module OnStomp::OpenURI::ClientExtensions
attr_reader :auto_destination, :openuri_message_queue
- # Aliases {#send_with_openuri} as +send+
+ # Aliases {#send_with_openuri} as `send`
def self.extended inst
inst.instance_eval do
alias :send_without_openuri :send
alias :send :send_with_openuri
alias :puts :send
@@ -41,12 +41,12 @@
else
OnStomp::ENUMERATOR_KLASS.new(self)
end
end
- # Returns +n+ frames read from the subscription. If +n+ is ommited,
- # the next frame is returned, otherwise an array of the next +n+ frames
+ # Returns `n` frames read from the subscription. If `n` is ommited,
+ # the next frame is returned, otherwise an array of the next `n` frames
# is returned.
# @see #each
# @param [Fixnum,nil] n
# @return [OnStomp::Components::Frame,Array<OnStomp::Components::Frame>]
def first(n=nil)
@@ -60,10 +60,10 @@
end
alias :take :first
alias :gets :first
# Assigns the auto destination. When a stomp:// URI is opened, this
- # will initially be set to the +path+ of the URI.
+ # will initially be set to the `path` of the URI.
# @param [String] dest
# @return [String,nil]
def auto_destination= dest
@auto_destination = (dest == '/') ? nil : dest
end