Doc update

Event.cs

@@ -23,7 +23,14 @@ namespace Terminal {
 	/// </remarks>
 	public enum Key : uint {
 		CharMask = 0xfffff,
+
+		/// <summary>
+		/// If the SpecialMask is set, then the value is that of the special mask,
+		/// otherwise, the value is the one of the lower bits (as extracted by CharMask).
+		/// </summary>
 		SpecialMask = 0xfff00000,
+
+
 		ControlA = 1,
 		ControlB,
 		ControlC,

Types/Point.cs

@@ -13,10 +13,20 @@ using System.Globalization;
 
 namespace Terminal
 {
+	/// <summary>
+	/// Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.
+	/// </summary>
 	public struct Point
 	{
-		// Private x and y coordinate fields.
-		public int X, Y;
+		/// <summary>
+		/// Gets or sets the x-coordinate of this Point.
+		/// </summary>
+		public int X;
+
+		/// <summary>
+		/// Gets or sets the y-coordinate of this Point.
+		/// </summary>
+		public int Y;
 
 		// -----------------------
 		// Public Shared Members
@@ -208,16 +218,34 @@ namespace Terminal
 			return string.Format ("{{X={0},Y={1}}}", X.ToString (CultureInfo.InvariantCulture), 
 				Y.ToString (CultureInfo.InvariantCulture));
 		}
+
+		/// <summary>
+		/// Adds the specified Size to the specified Point.
+		/// </summary>
+		/// <returns>The Point that is the result of the addition operation.</returns>
+		/// <param name="pt">The Point to add.</param>
+		/// <param name="sz">The Size to add.</param>
 		public static Point Add (Point pt, Size sz)
 		{
 			return new Point (pt.X + sz.Width, pt.Y + sz.Height);
 		}
 
+		/// <summary>
+		/// Translates this Point by the specified Point.
+		/// </summary>
+		/// <returns>The offset.</returns>
+		/// <param name="p">The Point used offset this Point.</param>
 		public void Offset (Point p)
 		{
 			Offset (p.X, p.Y);
 		}
 
+		/// <summary>
+		/// Returns the result of subtracting specified Size from the specified Point.
+		/// </summary>
+		/// <returns>The Point that is the result of the subtraction operation.</returns>
+		/// <param name="pt">The Point to be subtracted from.</param>
+		/// <param name="sz">The Size to subtract from the Point.</param>
 		public static Point Subtract (Point pt, Size sz)
 		{
 			return new Point (pt.X - sz.Width, pt.Y - sz.Height);

Types/Rect.cs

@@ -12,9 +12,29 @@ using System;
 
 namespace Terminal
 {
+	/// <summary>
+	/// Stores a set of four integers that represent the location and size of a rectangle
+	/// </summary>
 	public struct Rect
 	{
-		public int X, Y, Width, Height;
+		/// <summary>
+		/// Gets or sets the x-coordinate of the upper-left corner of this Rectangle structure.
+		/// </summary>
+		public int X;
+		/// <summary>
+		/// Gets or sets the y-coordinate of the upper-left corner of this Rectangle structure.
+		/// </summary>
+		public int Y;
+
+		/// <summary>
+		/// Gets or sets the width of this Rect structure.
+		/// </summary>
+		public int Width;
+
+		/// <summary>
+		/// Gets or sets the height of this Rectangle structure.
+		/// </summary>
+		public int Height;
 
 		/// <summary>
 		///	Empty Shared Field

Types/Size.cs

@@ -11,9 +11,16 @@
 using System;
 
 namespace Terminal {
+	/// <summary>
+	/// Stores an ordered pair of integers, which specify a Height and Width.
+	/// </summary>
 	public struct Size
 	{ 
 		private int width, height;
+
+		/// <summary>
+		/// Gets a Size structure that has a Height and Width value of 0.
+		/// </summary>
 		public static readonly Size Empty;
 
 		/// <summary>
@@ -208,6 +215,12 @@ namespace Terminal {
 			return String.Format ("{{Width={0}, Height={1}}}", width, height);
 		}
 
+		/// <summary>
+		/// Adds the width and height of one Size structure to the width and height of another Size structure.
+		/// </summary>
+		/// <returns>The add.</returns>
+		/// <param name="sz1">The first Size structure to add.</param>
+		/// <param name="sz2">The second Size structure to add.</param>
 		public static Size Add (Size sz1, Size sz2)
 		{
 			return new Size (sz1.Width + sz2.Width, 

docfx/api/Terminal/Terminal.Point.yml

@@ -30,6 +30,7 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.
   syntax:
     content: public struct Point
   inheritance:
@@ -94,18 +95,19 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Adds the specified Size to the specified Point.
   syntax:
     content: public static Terminal.Point Add (Terminal.Point pt, Terminal.Size sz);
     parameters:
     - id: pt
       type: Terminal.Point
-      description: To be added.
+      description: The Point to add.
     - id: sz
       type: Terminal.Size
-      description: To be added.
+      description: The Size to add.
     return:
       type: Terminal.Point
-      description: To be added.
+      description: The Point that is the result of the addition operation.
   overload: Terminal.Point.Add*
   exceptions: []
 - uid: Terminal.Point.Empty
@@ -233,12 +235,13 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Offset the specified p.
   syntax:
     content: public void Offset (Terminal.Point p);
     parameters:
     - id: p
       type: Terminal.Point
-      description: To be added.
+      description: P.
   overload: Terminal.Point.Offset*
   exceptions: []
 - uid: Terminal.Point.op_Addition(Terminal.Point,Terminal.Size)
@@ -440,6 +443,7 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Gets or sets the x-coordinate of this Point.
   syntax:
     content: public int X;
     return:
@@ -458,6 +462,7 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Gets or sets the y-coordinate of this Point.
   syntax:
     content: public int Y;
     return:

docfx/api/Terminal/Terminal.Rect.yml

@@ -44,6 +44,7 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Stores a set of four integers that represent the location and size of a rectangle
   syntax:
     content: public struct Rect
   inheritance:
@@ -323,6 +324,7 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Gets or sets the height of this Rectangle structure.
   syntax:
     content: public int Height;
     return:
@@ -781,6 +783,7 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Gets or sets the width of this Rect structure.
   syntax:
     content: public int Width;
     return:
@@ -799,6 +802,7 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Gets or sets the x-coordinate of the upper-left corner of this Rectangle structure.
   syntax:
     content: public int X;
     return:
@@ -817,6 +821,7 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Gets or sets the y-coordinate of the upper-left corner of this Rectangle structure.
   syntax:
     content: public int Y;
     return:

docfx/api/Terminal/Terminal.Size.yml

@@ -28,6 +28,7 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Stores an ordered pair of integers, which specify a Height and Width.
   syntax:
     content: public struct Size
   inheritance:
@@ -92,18 +93,19 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Adds the width and height of one Size structure to the width and height of another Size structure.
   syntax:
     content: public static Terminal.Size Add (Terminal.Size sz1, Terminal.Size sz2);
     parameters:
     - id: sz1
       type: Terminal.Size
-      description: To be added.
+      description: The first Size structure to add.
     - id: sz2
       type: Terminal.Size
-      description: To be added.
+      description: The second Size structure to add.
     return:
       type: Terminal.Size
-      description: To be added.
+      description: The add.
   overload: Terminal.Size.Add*
   exceptions: []
 - uid: Terminal.Size.Empty
@@ -118,6 +120,7 @@ items:
   assemblies:
   - Terminal
   namespace: Terminal
+  summary: Gets a Size structure that has a Height and Width value of 0.
   syntax:
     content: public static readonly Terminal.Size Empty;
     return:

docs/api/Terminal.html

@@ -147,11 +147,14 @@
       <section><p>Describes a mouse event</p>
 </section>
       <h4><a class="xref" href="Terminal/Terminal.Point.html">Point</a></h4>
-      <section></section>
+      <section><p>Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.</p>
+</section>
       <h4><a class="xref" href="Terminal/Terminal.Rect.html">Rect</a></h4>
-      <section></section>
+      <section><p>Stores a set of four integers that represent the location and size of a rectangle</p>
+</section>
       <h4><a class="xref" href="Terminal/Terminal.Size.html">Size</a></h4>
-      <section></section>
+      <section><p>Stores an ordered pair of integers, which specify a Height and Width.</p>
+</section>
     <h3 id="enums">Enums
   </h3>
       <h4><a class="xref" href="Terminal/Terminal.Color.html">Color</a></h4>

docs/api/Terminal/Terminal.Point.html

@@ -72,7 +72,8 @@
   
   <h1 id="Terminal_Point" data-uid="Terminal.Point">Struct Point
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.html">Terminal</a></h6>
   <h6><strong>Assembly</strong>: Terminal.dll</h6>
@@ -186,7 +187,8 @@
   
   
   <h4 id="Terminal_Point_X" data-uid="Terminal.Point.X">X</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets or sets the x-coordinate of this Point.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -211,7 +213,8 @@
   
   
   <h4 id="Terminal_Point_Y" data-uid="Terminal.Point.Y">Y</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets or sets the y-coordinate of this Point.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -271,7 +274,8 @@
   
   <a id="Terminal_Point_Add_" data-uid="Terminal.Point.Add*"></a>
   <h4 id="Terminal_Point_Add_Terminal_Point_Terminal_Size_" data-uid="Terminal.Point.Add(Terminal.Point,Terminal.Size)">Add(Point, Size)</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Adds the specified Size to the specified Point.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -290,13 +294,13 @@
       <tr>
         <td><a class="xref" href="Terminal.Point.html">Point</a></td>
         <td><span class="parametername">pt</span></td>
-        <td><p>To be added.</p>
+        <td><p>The Point to add.</p>
 </td>
       </tr>
       <tr>
         <td><a class="xref" href="Terminal.Size.html">Size</a></td>
         <td><span class="parametername">sz</span></td>
-        <td><p>To be added.</p>
+        <td><p>The Size to add.</p>
 </td>
       </tr>
     </tbody>
@@ -312,7 +316,7 @@
     <tbody>
       <tr>
         <td><a class="xref" href="Terminal.Point.html">Point</a></td>
-        <td><p>To be added.</p>
+        <td><p>The Point that is the result of the addition operation.</p>
 </td>
       </tr>
     </tbody>
@@ -437,7 +441,8 @@
   
   <a id="Terminal_Point_Offset_" data-uid="Terminal.Point.Offset*"></a>
   <h4 id="Terminal_Point_Offset_Terminal_Point_" data-uid="Terminal.Point.Offset(Terminal.Point)">Offset(Point)</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Offset the specified p.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -456,7 +461,7 @@
       <tr>
         <td><a class="xref" href="Terminal.Point.html">Point</a></td>
         <td><span class="parametername">p</span></td>
-        <td><p>To be added.</p>
+        <td><p>P.</p>
 </td>
       </tr>
     </tbody>

docs/api/Terminal/Terminal.Rect.html

@@ -72,7 +72,8 @@
   
   <h1 id="Terminal_Rect" data-uid="Terminal.Rect">Struct Rect
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>Stores a set of four integers that represent the location and size of a rectangle</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.html">Terminal</a></h6>
   <h6><strong>Assembly</strong>: Terminal.dll</h6>
@@ -205,7 +206,8 @@
   
   
   <h4 id="Terminal_Rect_Height" data-uid="Terminal.Rect.Height">Height</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets or sets the height of this Rectangle structure.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -230,7 +232,8 @@
   
   
   <h4 id="Terminal_Rect_Width" data-uid="Terminal.Rect.Width">Width</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets or sets the width of this Rect structure.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -255,7 +258,8 @@
   
   
   <h4 id="Terminal_Rect_X" data-uid="Terminal.Rect.X">X</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets or sets the x-coordinate of the upper-left corner of this Rectangle structure.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -280,7 +284,8 @@
   
   
   <h4 id="Terminal_Rect_Y" data-uid="Terminal.Rect.Y">Y</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets or sets the y-coordinate of the upper-left corner of this Rectangle structure.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">

docs/api/Terminal/Terminal.Size.html

@@ -72,7 +72,8 @@
   
   <h1 id="Terminal_Size" data-uid="Terminal.Size">Struct Size
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>Stores an ordered pair of integers, which specify a Height and Width.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.html">Terminal</a></h6>
   <h6><strong>Assembly</strong>: Terminal.dll</h6>
@@ -157,7 +158,8 @@
   
   
   <h4 id="Terminal_Size_Empty" data-uid="Terminal.Size.Empty">Empty</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets a Size structure that has a Height and Width value of 0.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -277,7 +279,8 @@
   
   <a id="Terminal_Size_Add_" data-uid="Terminal.Size.Add*"></a>
   <h4 id="Terminal_Size_Add_Terminal_Size_Terminal_Size_" data-uid="Terminal.Size.Add(Terminal.Size,Terminal.Size)">Add(Size, Size)</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Adds the width and height of one Size structure to the width and height of another Size structure.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -296,13 +299,13 @@
       <tr>
         <td><a class="xref" href="Terminal.Size.html">Size</a></td>
         <td><span class="parametername">sz1</span></td>
-        <td><p>To be added.</p>
+        <td><p>The first Size structure to add.</p>
 </td>
       </tr>
       <tr>
         <td><a class="xref" href="Terminal.Size.html">Size</a></td>
         <td><span class="parametername">sz2</span></td>
-        <td><p>To be added.</p>
+        <td><p>The second Size structure to add.</p>
 </td>
       </tr>
     </tbody>
@@ -318,7 +321,7 @@
     <tbody>
       <tr>
         <td><a class="xref" href="Terminal.Size.html">Size</a></td>
-        <td><p>To be added.</p>
+        <td><p>The add.</p>
 </td>
       </tr>
     </tbody>

ecmadocs/en/Terminal/Point.xml

@@ -10,7 +10,9 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>
+            Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.
+            </summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -71,10 +73,12 @@
         <Parameter Name="sz" Type="Terminal.Size" />
       </Parameters>
       <Docs>
-        <param name="pt">To be added.</param>
-        <param name="sz">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="pt">The Point to add.</param>
+        <param name="sz">The Size to add.</param>
+        <summary>
+            Adds the specified Size to the specified Point.
+            </summary>
+        <returns>The Point that is the result of the addition operation.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -176,8 +180,11 @@
         <Parameter Name="p" Type="Terminal.Point" />
       </Parameters>
       <Docs>
-        <param name="p">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="p">P.</param>
+        <summary>
+            Offset the specified p.
+            </summary>
+        <returns>The offset.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -395,7 +402,9 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>
+            Gets or sets the x-coordinate of this Point.
+            </summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -410,7 +419,9 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>
+            Gets or sets the y-coordinate of this Point.
+            </summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

ecmadocs/en/Terminal/Rect.xml

@@ -10,7 +10,9 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>
+            Stores a set of four integers that represent the location and size of a rectangle
+            </summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -265,7 +267,9 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>
+            Gets or sets the height of this Rectangle structure.
+            </summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -707,7 +711,9 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>
+            Gets or sets the width of this Rect structure.
+            </summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -722,7 +728,9 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>
+            Gets or sets the x-coordinate of the upper-left corner of this Rectangle structure.
+            </summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -737,7 +745,9 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>
+            Gets or sets the y-coordinate of the upper-left corner of this Rectangle structure.
+            </summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

ecmadocs/en/Terminal/Size.xml

@@ -10,7 +10,9 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>
+            Stores an ordered pair of integers, which specify a Height and Width.
+            </summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -71,10 +73,12 @@
         <Parameter Name="sz2" Type="Terminal.Size" />
       </Parameters>
       <Docs>
-        <param name="sz1">To be added.</param>
-        <param name="sz2">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="sz1">The first Size structure to add.</param>
+        <param name="sz2">The second Size structure to add.</param>
+        <summary>
+            Adds the width and height of one Size structure to the width and height of another Size structure.
+            </summary>
+        <returns>The add.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -89,7 +93,9 @@
         <ReturnType>Terminal.Size</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>
+            Gets a Size structure that has a Height and Width value of 0.
+            </summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>