aboutsummaryrefslogtreecommitdiffstats
path: root/Software
diff options
context:
space:
mode:
authorRoy Ben-Shabat <Roy@Twine-s.com>2018-01-14 13:26:15 +0200
committerRoy Ben-Shabat <Roy@Twine-s.com>2018-01-14 13:26:15 +0200
commitc23924624cd45b67eecc1c495c461bdc70bf551c (patch)
treedbf772575e87a9b144e2457b126951eb399963e0 /Software
parentd1fa1f1a2e26469a6bbb5b82ab614079beffcb52 (diff)
downloadTango-c23924624cd45b67eecc1c495c461bdc70bf551c.tar.gz
Tango-c23924624cd45b67eecc1c495c461bdc70bf551c.zip
Added code comments for:
Transport.
Diffstat (limited to 'Software')
-rw-r--r--Software/Visual_Studio/Tango.Transport/ITransportAdapter.cs4
-rw-r--r--Software/Visual_Studio/Tango.Transport/ITransportComponent.cs3
-rw-r--r--Software/Visual_Studio/Tango.Transport/ITransportEncoder.cs4
-rw-r--r--Software/Visual_Studio/Tango.Transport/TransportMessage.cs2
-rw-r--r--Software/Visual_Studio/Tango.Transport/TransportMessageBase.cs2
-rw-r--r--Software/Visual_Studio/Tango.Transport/TransportMessageDirection.cs2
6 files changed, 10 insertions, 7 deletions
diff --git a/Software/Visual_Studio/Tango.Transport/ITransportAdapter.cs b/Software/Visual_Studio/Tango.Transport/ITransportAdapter.cs
index 413ea7559..366125d64 100644
--- a/Software/Visual_Studio/Tango.Transport/ITransportAdapter.cs
+++ b/Software/Visual_Studio/Tango.Transport/ITransportAdapter.cs
@@ -9,7 +9,7 @@ using System.Threading.Tasks;
namespace Tango.Transport
{
/// <summary>
- /// Represents a transport adapter capable of connecting, writing and receiving data from a serial stream.
+ /// Represents a transport adapter capable of connecting, writing and receiving data from a stream.
/// </summary>
/// <seealso cref="Tango.Transport.ITransportComponent" />
public interface ITransportAdapter : ITransportComponent
@@ -36,7 +36,7 @@ namespace Tango.Transport
event EventHandler<byte[]> DataAvailable;
/// <summary>
- /// Gets or sets the channel address.
+ /// Gets or sets the adapter address.
/// </summary>
String Address { get; set; }
diff --git a/Software/Visual_Studio/Tango.Transport/ITransportComponent.cs b/Software/Visual_Studio/Tango.Transport/ITransportComponent.cs
index 06207ddf9..5266e0217 100644
--- a/Software/Visual_Studio/Tango.Transport/ITransportComponent.cs
+++ b/Software/Visual_Studio/Tango.Transport/ITransportComponent.cs
@@ -16,15 +16,18 @@ namespace Tango.Transport
/// </summary>
/// <returns></returns>
Task Connect();
+
/// <summary>
/// Disconnects the transport component.
/// </summary>
/// <returns></returns>
Task Disconnect();
+
/// <summary>
/// Occurs when component state changes.
/// </summary>
event EventHandler<TransportComponentState> StateChanged;
+
/// <summary>
/// Gets the component state.
/// </summary>
diff --git a/Software/Visual_Studio/Tango.Transport/ITransportEncoder.cs b/Software/Visual_Studio/Tango.Transport/ITransportEncoder.cs
index beae60d14..c0e4debbe 100644
--- a/Software/Visual_Studio/Tango.Transport/ITransportEncoder.cs
+++ b/Software/Visual_Studio/Tango.Transport/ITransportEncoder.cs
@@ -21,14 +21,14 @@ namespace Tango.Transport
byte[] Encode(ITangoMessage tangoMessage);
/// <summary>
- /// Decodes the specified data.
+ /// Decodes the specified data to an <see cref="ITangoMessage"/>.
/// </summary>
/// <param name="data">The data.</param>
/// <returns></returns>
ITangoMessage Decode(byte[] data);
/// <summary>
- /// Decodes only the container part of the message.
+ /// Decodes only the <see cref="MessageContainer"/> part of the message.
/// </summary>
/// <param name="data">The data.</param>
/// <returns></returns>
diff --git a/Software/Visual_Studio/Tango.Transport/TransportMessage.cs b/Software/Visual_Studio/Tango.Transport/TransportMessage.cs
index c3b3e87b3..47cc01efd 100644
--- a/Software/Visual_Studio/Tango.Transport/TransportMessage.cs
+++ b/Software/Visual_Studio/Tango.Transport/TransportMessage.cs
@@ -14,7 +14,7 @@ namespace Tango.Transport
/// </summary>
/// <typeparam name="T"></typeparam>
/// <seealso cref="Tango.Transport.TransportMessageBase" />
- public class TransportMessage<T> : TransportMessageBase
+ internal class TransportMessage<T> : TransportMessageBase
{
private TaskCompletionSource<T> _completionSource;
diff --git a/Software/Visual_Studio/Tango.Transport/TransportMessageBase.cs b/Software/Visual_Studio/Tango.Transport/TransportMessageBase.cs
index 27ad053be..8ef9aee5f 100644
--- a/Software/Visual_Studio/Tango.Transport/TransportMessageBase.cs
+++ b/Software/Visual_Studio/Tango.Transport/TransportMessageBase.cs
@@ -10,7 +10,7 @@ namespace Tango.Transport
/// <summary>
/// Represents a base transport message.
/// </summary>
- public abstract class TransportMessageBase
+ internal abstract class TransportMessageBase
{
/// <summary>
/// Gets or sets a value indicating whether this instance is multi response.
diff --git a/Software/Visual_Studio/Tango.Transport/TransportMessageDirection.cs b/Software/Visual_Studio/Tango.Transport/TransportMessageDirection.cs
index 6802afbdf..74d9136a5 100644
--- a/Software/Visual_Studio/Tango.Transport/TransportMessageDirection.cs
+++ b/Software/Visual_Studio/Tango.Transport/TransportMessageDirection.cs
@@ -9,7 +9,7 @@ namespace Tango.Transport
/// <summary>
/// Represents <see cref="TransportMessageBase"/> direction.
/// </summary>
- public enum TransportMessageDirection
+ internal enum TransportMessageDirection
{
/// <summary>
/// Request.