From e5cc9c5fe139abda3307b5d347a76babe6a05bb2 Mon Sep 17 00:00:00 2001
From: Jeffrey Phillips Freeman <the@jeffreyfreeman.me>
Date: Wed, 13 Sep 2023 15:25:06 -0400
Subject: [PATCH] Upgraded the documentation comments to remove references to
APXP and refer to AX.25 instead
---
lib/ax25/frame/frame.rb | 8 ++++----
lib/ax25/frame/immutable_message.rb | 18 +++++-------------
lib/ax25/frame/message.rb | 8 ++++----
3 files changed, 13 insertions(+), 21 deletions(-)
diff --git a/lib/ax25/frame/frame.rb b/lib/ax25/frame/frame.rb
index 445c15f..69cc4a3 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 a27b907..ad9d28b 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 52ab20a..d9134d2 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
--
GitLab