diff --git a/lib/ax25/frame/frame.rb b/lib/ax25/frame/frame.rb index 445c15f664ae714200e3003978cd05079107acdc..69cc4a38ccf6bfddbfd16de502d56683c11081ce 100644 --- a/lib/ax25/frame/frame.rb +++ b/lib/ax25/frame/frame.rb @@ -3,12 +3,12 @@ require 'ax25/frame/message' module Ax25 ## - # An APXP compatible APRS frame, excluding the path data entierly. The - # UnpathedFrame and all its fields are immutable. + # An AX.25 frame, including the path data. The Frame and all its fields are + # immutable. # # @example Comparing frames - # orig_frame = Ax25.new('WI2ARD-1', 'OMG', ['WIDE2-2' 'WIDE1-1'], 'payload goes here') - # diff_frame = Ax25.new('WI2ARD-1', 'OMG', ['WIDE2-2' 'WIDE1-1'], 'different payload') + # orig_frame = Frame.new('WI2ARD-1', 'OMG', ['WIDE2-2' 'WIDE1-1'], 'payload goes here') + # diff_frame = Frame.new('WI2ARD-1', 'OMG', ['WIDE2-2' 'WIDE1-1'], 'different payload') # assert not orig_frame.eql? diff_frame public module Frame diff --git a/lib/ax25/frame/immutable_message.rb b/lib/ax25/frame/immutable_message.rb index a27b9077a8a1f0aac108986def15a6175b96f958..ad9d28bb648bff2207e209bc90f8e4d03e4c0de9 100644 --- a/lib/ax25/frame/immutable_message.rb +++ b/lib/ax25/frame/immutable_message.rb @@ -1,28 +1,20 @@ require 'ax25/frame/message' module Ax25 - ## - # An APXP compatible APRS frame, excluding the path data entierly. The - # UnpathedFrame and all its fields are immutable. - # - # @example Comparing frames - # orig_frame = Ax25.new('WI2ARD-1', 'OMG', ['WIDE2-2' 'WIDE1-1'], 'payload goes here') - # diff_frame = Ax25.new('WI2ARD-1', 'OMG', ['WIDE2-2' 'WIDE1-1'], 'different payload') - # assert not orig_frame.eql? diff_frame public class ImmutableMessage include Message ## - # Creates a new frame, all fields are duplicated but and immutable. All + # Creates a new frame, all fields are duplicated and are immutable. All # fields are validated. # - # @param source [Ax25::Address] The source entity for the frame. Must be a + # @param source [Ax25::Address] The source of the frame. Must be a # non-null string of non-zero length with only letters, numbers and - # dashes. Will be converted uppercase. - # @param destination [Ax25::Address] The destination entity for the frame. Must + # dashes + # @param destination [Ax25::Address] The destination for the frame. Must # be a non-null string of non-zero length with only letters, numbers, - # and dashes. Will be converted to uppercase. + # and dashes. # @param payload [String] The payload of the frame. Must be a non-null # string of non-zero length. protected diff --git a/lib/ax25/frame/message.rb b/lib/ax25/frame/message.rb index 52ab20a1fd7103bfd6e79102d96e8883600064ff..d9134d23c6c1c22446f09315c230b4897593f98c 100644 --- a/lib/ax25/frame/message.rb +++ b/lib/ax25/frame/message.rb @@ -2,12 +2,12 @@ require 'abstractify' module Ax25 ## - # An APXP compatible APRS frame, excluding the path data entierly. The - # UnpathedFrame and all its fields are immutable. + # An AX.25 frame, excluding the path data entierly. The Frame and all its + # fields are immutable. # # @example Comparing frames - # orig_frame = Ax25.new('WI2ARD-1', 'OMG', ['WIDE2-2' 'WIDE1-1'], 'payload goes here') - # diff_frame = Ax25.new('WI2ARD-1', 'OMG', ['WIDE2-2' 'WIDE1-1'], 'different payload') + # orig_frame = Message.new('WI2ARD-1', 'OMG', ['WIDE2-2' 'WIDE1-1'], 'payload goes here') + # diff_frame = Message.new('WI2ARD-1', 'OMG', ['WIDE2-2' 'WIDE1-1'], 'different payload') # assert not orig_frame.eql? diff_frame public module Message