From 4bd382c47810086b8064874e142896b99ecea6bb Mon Sep 17 00:00:00 2001
From: Jeffrey Phillips Freeman <the@jeffreyfreeman.me>
Date: Wed, 16 Aug 2023 11:47:23 -0400
Subject: [PATCH] Added a bit of minor documentation
---
lib/apex/encoder/aprs_kiss.rb | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/lib/apex/encoder/aprs_kiss.rb b/lib/apex/encoder/aprs_kiss.rb
index be3a857..fa4ec7e 100644
--- a/lib/apex/encoder/aprs_kiss.rb
+++ b/lib/apex/encoder/aprs_kiss.rb
@@ -3,6 +3,11 @@ require 'apex/frame'
module Apex
class AprsKiss
+ ##
+ # Creates a new AprsKiss encoder
+ #
+ # @param data_stream [Kiss::KissAbstract] The underlying data stream
+ # frames are written to.
protected
def initialize(data_stream)
@data_stream = data_stream
--
GitLab