# HG changeset patch
# User StephaneLenclud
# Date 1432635835 -7200
# Node ID 426cc984fd180aaa48d4e6e71ef140a70c450312
# Parent  8badd89fb78ca801593b0dafd1780f424d4b8698
Documentation and minor clean-up.

diff -r 8badd89fb78c -r 426cc984fd18 Client/Client.cs
--- a/Client/Client.cs	Wed May 06 22:07:32 2015 +0200
+++ b/Client/Client.cs	Tue May 26 12:23:55 2015 +0200
@@ -31,7 +31,7 @@
 namespace SharpDisplayClient
 {
     /// <summary>
-    ///
+    /// Client side Sharp Display callback implementation.
     /// </summary>
     [ServiceBehavior(ConcurrencyMode = ConcurrencyMode.Multiple)]
     public class Callback : ICallback, IDisposable
@@ -43,6 +43,9 @@
             MainForm = aMainForm;
         }
 
+        /// <summary>
+        /// Not used I believe.
+        /// </summary>
         public void OnConnected()
         {
             //Debug.Assert(Thread.CurrentThread.IsThreadPoolThread);
@@ -71,7 +74,7 @@
 
 
     /// <summary>
-    ///
+    /// Client side implementation of our Sharp Display Service.
     /// </summary>
     [ServiceBehavior(ConcurrencyMode = ConcurrencyMode.Multiple)]
     public class Client : DuplexClientBase<IService>
@@ -200,6 +203,12 @@
             }
         }
 
+        /// <summary>
+        /// Set our client's name.
+        /// Client's name is typically user friendly.
+        /// It does not have to be unique.
+        /// </summary>
+        /// <param name="aClientName">Our client name.</param>
         public void SetName(string aClientName)
         {
             Name = aClientName;
@@ -207,7 +216,10 @@
             iClient.SetName(aClientName);
         }
 
-
+        /// <summary>
+        /// Set your client fields' layout.
+        /// </summary>
+        /// <param name="aLayout">The layout to apply for this client.</param>
         public void SetLayout(TableLayout aLayout)
         {
             Layout = aLayout;
@@ -238,7 +250,7 @@
 
             if (!fieldFound)
             {
-                //Field not found, make to use SetFields with all your fields at least once after setting your layout.
+                //Field not found, make sure to use CreateFields first after setting your layout.
                 return false;
             }
 
@@ -274,7 +286,7 @@
             //
             if (fieldFoundCount!=aFields.Count)
             {
-                //Field not found, make sure to use SetFields with all your fields at least once after setting your layout.
+                //Field not found, make sure to use CreateFields first after setting your layout.
                 return false;
             }
 
@@ -285,6 +297,7 @@
 
         /// <summary>
         /// Use this function when creating your fields.
+        /// This must be done at least once after setting your layout.
         /// </summary>
         /// <param name="aFields"></param>
         public void CreateFields(System.Collections.Generic.IList<DataField> aFields)
@@ -294,6 +307,10 @@
             iClient.SetFields(aFields);
         }
 
+        /// <summary>
+        /// Provide the number of clients currently connected to our server.
+        /// </summary>
+        /// <returns>Number of clients currently connected to our server.</returns>
         public int ClientCount()
         {
             CheckConnection();
diff -r 8badd89fb78c -r 426cc984fd18 Interface/Interface.cs
--- a/Interface/Interface.cs	Wed May 06 22:07:32 2015 +0200
+++ b/Interface/Interface.cs	Tue May 26 12:23:55 2015 +0200
@@ -18,6 +18,7 @@
 {
     /// <summary>
     /// For client to specify a specific layout.
+    /// A table layout is sent from client to server and defines data fields layout on our display.
     /// </summary>
     [DataContract]
     public class TableLayout
@@ -26,9 +27,13 @@
         {
             Columns = new List<ColumnStyle>();
             Rows = new List<RowStyle>();
-            Cells = new List<DataField>();
         }
 
+        /// <summary>
+        /// Construct our table layout.
+        /// </summary>
+        /// <param name="aColumnCount">Number of column in our table.</param>
+        /// <param name="aRowCount">Number of rows in our table.</param>
         public TableLayout(int aColumnCount, int aRowCount)
         {
             Columns = new List<ColumnStyle>();
@@ -46,9 +51,6 @@
         }
 
         [DataMember]
-        public List<DataField> Cells { get; set; }
-
-        [DataMember]
         public List<ColumnStyle> Columns { get; set; }
 
         [DataMember]
@@ -56,7 +58,8 @@
     }
 
     /// <summary>
-    ///
+    /// Define a data field on our display.
+    /// Data field can be either text or bitmap.
     /// </summary>
     [DataContract]
     public class DataField
diff -r 8badd89fb78c -r 426cc984fd18 Server/MainForm.Hid.cs
--- a/Server/MainForm.Hid.cs	Wed May 06 22:07:32 2015 +0200
+++ b/Server/MainForm.Hid.cs	Tue May 26 12:23:55 2015 +0200
@@ -13,6 +13,9 @@
 
 namespace SharpDisplayManager
 {
+    /// <summary>
+    /// Implement handling of HID input reports notably to be able to launch an application using the Green Start button from IR remotes.
+    /// </summary>
     [System.ComponentModel.DesignerCategory("Code")]
     public class MainFormHid : Form
     {