Doc comments

This commit is contained in:
mort5161 2014-11-11 17:44:02 -08:00
parent 8e6cc7b00b
commit 5f660c3343
6 changed files with 184 additions and 3 deletions

View file

@ -40,11 +40,19 @@ namespace NmeaParser
private BTDevice m_device;
private StreamSocket m_socket;
/// <summary>
/// Initializes a new instance of the <see cref="BluetoothDevice"/> class.
/// </summary>
/// <param name="device">The device.</param>
public BluetoothDevice(BTDevice device)
{
m_device = device;
}
/// <summary>
/// Creates the stream the NmeaDevice is working on top off.
/// </summary>
/// <returns></returns>
protected override async Task<System.IO.Stream> OpenStreamAsync()
{
var socket = new Windows.Networking.Sockets.StreamSocket();
@ -59,6 +67,11 @@ namespace NmeaParser
return socket.InputStream.AsStreamForRead();
}
/// <summary>
/// Closes the stream the NmeaDevice is working on top off.
/// </summary>
/// <param name="stream">The stream.</param>
/// <returns></returns>
protected override Task CloseStreamAsync(System.IO.Stream stream)
{
stream.Dispose();