diff --git a/src/NmeaParser.Shared/BufferedStreamDevice.cs b/src/NmeaParser.Shared/BufferedStreamDevice.cs index aa71bdf..1731d4b 100644 --- a/src/NmeaParser.Shared/BufferedStreamDevice.cs +++ b/src/NmeaParser.Shared/BufferedStreamDevice.cs @@ -23,6 +23,10 @@ using System.Threading.Tasks; namespace NmeaParser { + /// + /// An abstract generic NMEA device that reads a stream at a decreased pace, + /// mostly used to emulate NMEA input from files and strings. + /// public abstract class BufferedStreamDevice : NmeaDevice { BufferedStream m_stream; @@ -36,6 +40,7 @@ namespace NmeaParser { m_readSpeed = readSpeed; } + protected abstract Task GetStreamAsync(); protected sealed async override Task OpenStreamAsync() @@ -52,8 +57,8 @@ namespace NmeaParser return Task.FromResult(true); } - // stream that slowly populates a buffer from a StreamReader to simulate nmea messages coming in line by line - // at a steady stream + // stream that slowly populates a buffer from a StreamReader to simulate nmea messages coming + // in line by line at a steady stream private class BufferedStream : Stream { StreamReader m_sr; diff --git a/src/NmeaParser.Shared/NmeaDevice.cs b/src/NmeaParser.Shared/NmeaDevice.cs index 75ef547..af37abb 100644 --- a/src/NmeaParser.Shared/NmeaDevice.cs +++ b/src/NmeaParser.Shared/NmeaDevice.cs @@ -24,6 +24,9 @@ using Windows.Foundation; namespace NmeaParser { + /// + /// A generic abstract NMEA device + /// public abstract class NmeaDevice : IDisposable { private object m_lockObject = new object(); diff --git a/src/NmeaParser.Shared/NmeaFileDevice.cs b/src/NmeaParser.Shared/NmeaFileDevice.cs index e57809a..d3abab5 100644 --- a/src/NmeaParser.Shared/NmeaFileDevice.cs +++ b/src/NmeaParser.Shared/NmeaFileDevice.cs @@ -23,6 +23,9 @@ using System.Threading.Tasks; namespace NmeaParser { + /// + /// A file-based NMEA device reading from a NMEA log file. + /// public class NmeaFileDevice : BufferedStreamDevice { #if NETFX_CORE diff --git a/src/NmeaParser.WinStore/BluetoothDevice.cs b/src/NmeaParser.WinStore/BluetoothDevice.cs index a083a4e..ac51902 100644 --- a/src/NmeaParser.WinStore/BluetoothDevice.cs +++ b/src/NmeaParser.WinStore/BluetoothDevice.cs @@ -32,6 +32,9 @@ using BTDevice = Windows.Networking.Proximity.PeerInformation; namespace NmeaParser { + /// + /// A Bluetooth NMEA device + /// public class BluetoothDevice : NmeaDevice { private BTDevice m_device;