From 1a9b10d6e46f8015c19a592ade346cb10b01b989 Mon Sep 17 00:00:00 2001
From: Miguel de Icaza <miguel@gnome.org>
Date: Thu, 11 Aug 2016 23:50:00 -0400
Subject: [PATCH] Updated docs

---
 docs/en/SkiaSharp/SKBitmap.xml     | 33 ++++++++++++------------------
 docs/en/SkiaSharp/SKColorTable.xml | 28 +++++++++++++++----------
 2 files changed, 30 insertions(+), 31 deletions(-)

diff --git a/docs/en/SkiaSharp/SKBitmap.xml b/docs/en/SkiaSharp/SKBitmap.xml
index d54cd1a6..6d703c51 100644
--- a/docs/en/SkiaSharp/SKBitmap.xml
+++ b/docs/en/SkiaSharp/SKBitmap.xml
@@ -36,8 +36,7 @@
         <summary>Default construct creates a bitmap with zero width and height, and no pixels. Its colortype is set to <see cref="E:SkiaSharp.SKColorType.Unknown." /></summary>
         <remarks>
           <para>This constructor does not allocate a backing store for the bitmap.</para>
-          <para>
-          </para>
+          <para></para>
         </remarks>
       </Docs>
     </Member>
@@ -71,10 +70,10 @@
         <Parameter Name="ctable" Type="SkiaSharp.SKColorTable" />
       </Parameters>
       <Docs>
-        <param name="info">To be added.</param>
-        <param name="ctable">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="info">Description of the desired image format.</param>
+        <param name="ctable">Color lookup table</param>
+        <summary>Constructor that configures the bitmap based on an <see cref="T:SkiaSharp.SKImageInfo" /> specification and a color table.</summary>
+        <remarks>Use this method to create a bitmap that will use a color lookup table.   The bitmap will be an 8-bit indexed bitmap, where each value represents an index into the color table, and the color is determined by the value in the specific location in the color table array.</remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -92,8 +91,8 @@
         <Parameter Name="rowBytes" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <param name="info">To be added.</param>
-        <param name="rowBytes">To be added.</param>
+        <param name="info">Description of the desired image format.</param>
+        <param name="rowBytes">The number of bytes per row.</param>
         <summary>Constructor that configures the bitmap based on an <see cref="T:SkiaSharp.SKImageInfo" /> specification, and the specified number of bytes per row (the stride size)</summary>
         <remarks>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</remarks>
       </Docs>
@@ -120,8 +119,7 @@
         <summary>Creates a bitmap with the given width, height and opacity with color type set to <see cref="E:SkiaSharp.SKColorType.N_32" /></summary>
         <remarks>
           <para>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</para>
-          <para>
-          </para>
+          <para></para>
         </remarks>
       </Docs>
     </Member>
@@ -166,8 +164,7 @@
       <Docs>
         <summary>Returns the configured alpha type for the bitmap.</summary>
         <value>
-          <para>
-          </para>
+          <para></para>
         </value>
         <remarks>This determines the kind of encoding used for the alpha channel, opaque, premultiplied or unpremultiplied.</remarks>
       </Docs>
@@ -304,8 +301,7 @@
         <summary>Copies the contents of the bitmap and returns the copy.</summary>
         <returns>The copy of the bitmap, or <paramref name="null" /> on error.</returns>
         <remarks>
-          <para>
-          </para>
+          <para></para>
         </remarks>
       </Docs>
     </Member>
@@ -854,8 +850,7 @@
         <summary>Returns the address of the pixels for this SKBitmap</summary>
         <returns>Returns a pointer to the region that contains the pixel data for this bitmap.   This might return <see langword="null" /> if there is no pixel buffer associated with this bitmap.</returns>
         <remarks>
-          <para>
-          </para>
+          <para></para>
         </remarks>
       </Docs>
     </Member>
@@ -934,8 +929,7 @@
         <value>
           <see langword="true" /> if it is immutable, <see langword="false" /> otherwise.</value>
         <remarks>
-          <para>
-          </para>
+          <para></para>
         </remarks>
       </Docs>
     </Member>
@@ -1125,8 +1119,7 @@
         <summary>Call this to balance a previous call to <see cref="M:SkiaSharp.SKBitmap.LockPixels" />.</summary>
         <remarks>
           <para>When you are finished access the pixel memory, call this to balance a previous call to <see cref="M:SkiaSharp.SKBitmap.LockPixels" />. This allows pixelrefs that implement cached/deferred image decoding to know when there are active clients of a given image.</para>
-          <para>
-          </para>
+          <para></para>
         </remarks>
       </Docs>
     </Member>
diff --git a/docs/en/SkiaSharp/SKColorTable.xml b/docs/en/SkiaSharp/SKColorTable.xml
index 88571327..8e650542 100644
--- a/docs/en/SkiaSharp/SKColorTable.xml
+++ b/docs/en/SkiaSharp/SKColorTable.xml
@@ -9,8 +9,14 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>Holds a color table for indexed 8-bit bitmaps.</summary>
+    <remarks>
+      <para>This class is used to represent a color lookup table for indexed bitmap images.</para>
+      <para />
+      <para>The table can contain up to 256 colors (8 bits).</para>
+      <para />
+      <para>The colors are stored are pre-multiplied 32-bit colors.</para>
+    </remarks>
   </Docs>
   <Members>
     <Member MemberName=".ctor">
@@ -21,7 +27,7 @@
       </AssemblyInfo>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Creates a new emtpy color table with 256 emtpy elements.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -36,7 +42,7 @@
       </Parameters>
       <Docs>
         <param name="colors">To be added.</param>
-        <summary>To be added.</summary>
+        <summary>Creates a color table with the provided colors, up to 256 colors can be provided.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -51,7 +57,7 @@
       </Parameters>
       <Docs>
         <param name="count">To be added.</param>
-        <summary>To be added.</summary>
+        <summary>Creates a color table with the specified number of elements, with empty colors.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -68,7 +74,7 @@
       <Docs>
         <param name="colors">To be added.</param>
         <param name="count">To be added.</param>
-        <summary>To be added.</summary>
+        <summary>Creates a color table with the provided colors, but only consumes the first count elements from the colors array.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -82,7 +88,7 @@
         <ReturnType>SkiaSharp.SKColor[]</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Gets a copy of the colors in the color table.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -97,7 +103,7 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>The number of colors in the lookup table.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -116,7 +122,7 @@
       </Parameters>
       <Docs>
         <param name="disposing">To be added.</param>
-        <summary>To be added.</summary>
+        <summary>Use this to dispose this object by subclasses.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -131,7 +137,7 @@
       </ReturnValue>
       <MemberValue>256</MemberValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>The maximum number of colors in the color lookup table.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -146,7 +152,7 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Returns an unmanaged pointer to the color lookup table.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>