Interface/Interface.cs
changeset 56 e86d84480b32
parent 55 b5ed2e29be23
child 62 ac698f4e1b36
     1.1 --- a/Interface/Interface.cs	Sun Sep 21 13:15:52 2014 +0200
     1.2 +++ b/Interface/Interface.cs	Sun Sep 21 13:40:21 2014 +0200
     1.3 @@ -1,4 +1,8 @@
     1.4 -using System;
     1.5 +//
     1.6 +// Define a public API for both SharpDisplay client and server to use.
     1.7 +//
     1.8 +
     1.9 +using System;
    1.10  using System.Collections.Generic;
    1.11  using System.Linq;
    1.12  using System.Text;
    1.13 @@ -11,6 +15,9 @@
    1.14  
    1.15  namespace SharpDisplay
    1.16  {
    1.17 +    /// <summary>
    1.18 +    /// TextField can be send to our server to be displayed on the screen.
    1.19 +    /// </summary>
    1.20      [DataContract]
    1.21      public class TextField
    1.22      {
    1.23 @@ -38,7 +45,12 @@
    1.24          public ContentAlignment Alignment { get; set; }
    1.25      }
    1.26  
    1.27 -
    1.28 +    /// <summary>
    1.29 +    /// Define our SharpDisplay service.
    1.30 +    /// Clients and servers must implement it to communicate with one another.
    1.31 +    /// Through this service clients can send requests to a server.
    1.32 +    /// Through this service a server session can receive requests from a client.
    1.33 +    /// </summary>
    1.34      [ServiceContract(   CallbackContract = typeof(ICallback), SessionMode = SessionMode.Required)]
    1.35      public interface IService
    1.36      {
    1.37 @@ -76,7 +88,9 @@
    1.38  
    1.39      }
    1.40  
    1.41 -
    1.42 +    /// <summary>
    1.43 +    /// SharDisplay callback provides a means for a server to notify its clients.
    1.44 +    /// </summary>
    1.45      public interface ICallback
    1.46      {
    1.47          [OperationContract(IsOneWay = true)]