Updated the API docs for all except:

- SkiaSharp.SK3dView - SkiaSharp.SKMask
mono · Feb 1, 2017 · 21306d6 · 21306d6
1 parent 4ab6cb0
commit 21306d6
Show file tree

Hide file tree

Showing 12 changed files with 187 additions and 112 deletions.
diff --git a/docs/en/SkiaSharp/SKAutoMaskFreeImage.xml b/docs/en/SkiaSharp/SKAutoMaskFreeImage.xml
@@ -14,8 +14,23 @@
     </Interface>
   </Interfaces>
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>Convenience class used to automatically free the image data for a mask in a using statement.</summary>
+    <remarks>
+      <para>This class can be used in a using statement to automatically free the image data of a mask by virtue of having the <see cref="M:SkiaSharp.SKAutoMaskFreeImage.Dispose" /> method.</para>
+      <para></para>
+      <example>
+        <code lang="C#"><![CDATA[// some buffer
+byte[] buffer = ...;
+
+// create the mask, allocating the image
+var mask = SKMask.Create(buffer, bounds, rowBytes, format);
+using (new SKAutoMaskFreeImage(mask.Image)) {
+    // use the mask
+
+    // automatically release the image data
+}]]></code>
+      </example>
+    </remarks>
   </Docs>
   <Members>
     <Member MemberName=".ctor">
@@ -29,9 +44,11 @@
         <Parameter Name="maskImage" Type="System.IntPtr" />
       </Parameters>
       <Docs>
-        <param name="maskImage">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="maskImage">The image to free.</param>
+        <summary>Create a new instance of <see cref="T:SkiaSharp.SKAutoMaskFreeImage" /> with the specified image to free.</summary>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Dispose">
@@ -46,8 +63,10 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <summary>Disposes the object, releasing the image data.</summary>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
   </Members>

diff --git a/docs/en/SkiaSharp/SKBitmap.xml b/docs/en/SkiaSharp/SKBitmap.xml
@@ -1135,10 +1135,10 @@
         <Parameter Name="mask" Type="SkiaSharp.SKMask" />
       </Parameters>
       <Docs>
-        <param name="mask">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="mask">The mask to install.</param>
+        <summary>Installs the specified mask’s pixels into the bitmap.</summary>
+        <returns>Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty.</returns>
+        <remarks>The caller must ensure that the specified mask pixels are valid for the lifetime of the created bitmap.</remarks>
       </Docs>
     </Member>
     <Member MemberName="InstallPixels">

diff --git a/docs/en/SkiaSharp/SKCanvas.xml b/docs/en/SkiaSharp/SKCanvas.xml
@@ -23,9 +23,9 @@
       <para></para>
       <para>This includes a reference to the device itself, and a stack of matrix/clip values. For any given draw call (e.g. drawRect), the geometry of the object being drawn is transformed by the concatenation of all the matrices in the stack. The transformed geometry is clipped by the intersection of all of the clips in the stack.</para>
       <para></para>
-      <para>While the Canvas holds the state of the drawing device, the state (style) of the object being drawn is held by the Paint, which is provided as a parameter to each of the draw() methods. The Paint holds attributes such as color, typeface, the text size, the stroke width, the shader (for example, gradients, patterns), etc.</para>
+      <para>While the canvas holds the state of the drawing device, the state (style) of the object being drawn is held by the Paint, which is provided as a parameter to each of the draw() methods. The Paint holds attributes such as color, typeface, the text size, the stroke width, the shader (for example, gradients, patterns), etc.</para>
       <para></para>
-      <para>The SkCanvas is returned when accessing the <see cref="P:SkiaSharp.SKSurface.Canvas" /> property of a surface.</para>
+      <para>The SKCanvas is returned when accessing the <see cref="P:SkiaSharp.SKSurface.Canvas" /> property of a surface.</para>
       <para>Transformations</para>
       <para>The <see cref="T:SkiaSharp.SKCanvas" /> supports a number of 2D transformations.   Unlike other 2D graphic systems like CoreGraphics or Cairo, SKCanvas extends the transformations to include perspectives.   </para>
       <para>You can use the <see cref="M:SkiaSharp.SKCanvas.Scale" />, <see cref="M:SkiaSharp.SKCanvas.Skew" />, <see cref="M:SkiaSharp.SKCanvas.Translate" />, <see cref="M:SkiaSharp.SKCanvas.RotateDegrees" />, <see cref="M:SkiaSharp.SKCanvas.RotateRadians" /> to perform some of the most common 2D transformations.   </para>
@@ -448,11 +448,14 @@
         <Parameter Name="value" Type="SkiaSharp.SKData" />
       </Parameters>
       <Docs>
-        <param name="rect">To be added.</param>
-        <param name="key">To be added.</param>
-        <param name="value">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="rect">The bounds of the annotation.</param>
+        <param name="key">The name of the annotation.</param>
+        <param name="value">The blob of data to attach to the annotation.</param>
+        <summary>Send an key/value pair "annotation" to the canvas.</summary>
+        <remarks>
+          <para>The caller still retains its ownership of the data (if any).</para>
+          <para>Note: on may canvas types, this information is ignored, but some canvases (e.g. recording a picture or drawing to a PDF document) will pass on this information.</para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="DrawBitmap">
@@ -978,10 +981,13 @@
         <Parameter Name="value" Type="SkiaSharp.SKData" />
       </Parameters>
       <Docs>
-        <param name="rect">To be added.</param>
-        <param name="value">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="rect">The bounds of the annotation.</param>
+        <param name="value">The data that specifies the name of the link’s destination.</param>
+        <summary>Annotates the canvas by making the specified rectangle link to a named destination (see <see cref="M:SkiaSharp.SKCanvas.DrawNamedDestinationAnnotation" />).</summary>
+        <remarks>
+          <para>The caller is responsible for managing its ownership of the data.</para>
+          <para>If the backend of this canvas does not support annotations, this call is safely ignored.</para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="DrawLinkDestinationAnnotation">
@@ -999,11 +1005,11 @@
         <Parameter Name="value" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="rect">To be added.</param>
-        <param name="value">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="rect">The bounds of the annotation.</param>
+        <param name="value">The name of the link’s destination.</param>
+        <summary>Annotates the canvas by making the specified rectangle link to a named destination (see <see cref="M:SkiaSharp.SKCanvas.DrawNamedDestinationAnnotation" />).</summary>
+        <returns>Returns the actual data object that was attached to the canvas.</returns>
+        <remarks>If the backend of this canvas does not support annotations, this call is safely ignored.</remarks>
       </Docs>
     </Member>
     <Member MemberName="DrawNamedDestinationAnnotation">
@@ -1021,10 +1027,13 @@
         <Parameter Name="value" Type="SkiaSharp.SKData" />
       </Parameters>
       <Docs>
-        <param name="point">To be added.</param>
-        <param name="value">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="point">The location of the destination.</param>
+        <param name="value">The data that specifies the name of the destination.</param>
+        <summary>Annotates the canvas by associating a name with the specified point (see <see cref="M:SkiaSharp.SKCanvas.DrawLinkDestinationAnnotation" />).</summary>
+        <remarks>
+          <para>The caller is responsible for managing its ownership of the data.</para>
+          <para>If the backend of this canvas does not support annotations, this call is safely ignored.</para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="DrawNamedDestinationAnnotation">
@@ -1042,11 +1051,11 @@
         <Parameter Name="value" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="point">To be added.</param>
-        <param name="value">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="point">The location of the destination.</param>
+        <param name="value">The name of the destination.</param>
+        <summary>Annotates the canvas by associating a name with the specified point (see <see cref="M:SkiaSharp.SKCanvas.DrawLinkDestinationAnnotation" />).</summary>
+        <returns>Returns the actual data object that was attached to the canvas.</returns>
+        <remarks>If the backend of this canvas does not support annotations, this call is safely ignored.</remarks>
       </Docs>
     </Member>
     <Member MemberName="DrawOval">
@@ -1744,10 +1753,13 @@
         <Parameter Name="value" Type="SkiaSharp.SKData" />
       </Parameters>
       <Docs>
-        <param name="rect">To be added.</param>
-        <param name="value">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="rect">The bounds of the annotation.</param>
+        <param name="value">The data that specifies the URL.</param>
+        <summary>Annotates the canvas by associating the specified URL with the specified rectangle (in local coordinates, just like <see cref="M:SkiaSharp.SKCanvas.DrawRect" />).</summary>
+        <remarks>
+          <para>The caller is responsible for managing its ownership of the data.</para>
+          <para>If the backend of this canvas does not support annotations, this call is safely ignored.</para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="DrawUrlAnnotation">
@@ -1765,11 +1777,11 @@
         <Parameter Name="value" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="rect">To be added.</param>
-        <param name="value">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="rect">The bounds of the annotation.</param>
+        <param name="value">The URL.</param>
+        <summary>Annotates the canvas by associating the specified URL with the specified rectangle (in local coordinates, just like <see cref="M:SkiaSharp.SKCanvas.DrawRect" />).</summary>
+        <returns>Returns the actual data object that was attached to the canvas.</returns>
+        <remarks>If the backend of this canvas does not support annotations, this call is safely ignored.</remarks>
       </Docs>
     </Member>
     <Member MemberName="Flush">

diff --git a/docs/en/SkiaSharp/SKData.xml b/docs/en/SkiaSharp/SKData.xml
@@ -85,10 +85,12 @@
         <Parameter Name="length" Type="System.UInt64" />
       </Parameters>
       <Docs>
-        <param name="bytes">To be added.</param>
-        <param name="length">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="bytes">The array of bytes that will be copied.</param>
+        <param name="length">The size of the buffer to create.</param>
+        <summary>Creates an <see cref="T:SkiaSharp.SKData" /> by copying the provided byte array for the specified size.</summary>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">

diff --git a/docs/en/SkiaSharp/SKDocument.xml b/docs/en/SkiaSharp/SKDocument.xml
@@ -193,12 +193,12 @@
         <Parameter Name="dpi" Type="System.Single" />
       </Parameters>
       <Docs>
-        <param name="stream">To be added.</param>
-        <param name="metadata">To be added.</param>
-        <param name="dpi">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="stream">The stream to write to.</param>
+        <param name="metadata">The document metadata to include.</param>
+        <param name="dpi">The DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</param>
+        <summary>Create a PDF-backed document with the specified metadata, writing the results into a stream.</summary>
+        <returns>Returns the new PDF-backed document.</returns>
+        <remarks>PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
       </Docs>
     </Member>
     <Member MemberName="DefaultRasterDpi">

diff --git a/docs/en/SkiaSharp/SKDocumentPdfMetadata.xml b/docs/en/SkiaSharp/SKDocumentPdfMetadata.xml
@@ -10,8 +10,10 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>Optional metadata to be passed into the PDF factory function.</summary>
+    <remarks>
+      <para />
+    </remarks>
   </Docs>
   <Members>
     <Member MemberName="Author">
@@ -25,9 +27,13 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>The name of the person who created the document.</summary>
+        <value>
+          <para />
+        </value>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Creation">
@@ -41,9 +47,13 @@
         <ReturnType>System.Nullable&lt;System.DateTime&gt;</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>The date and time the document was created.</summary>
+        <value>
+          <para />
+        </value>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Creator">
@@ -57,9 +67,13 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>The name of the product that created the original document, if the document was converted to PDF from another format.</summary>
+        <value>
+          <para />
+        </value>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Keywords">
@@ -73,9 +87,13 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Comma-separated keywords associated with the document.</summary>
+        <value>
+          <para />
+        </value>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Modified">
@@ -89,9 +107,13 @@
         <ReturnType>System.Nullable&lt;System.DateTime&gt;</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>The date and time the document was most recently modified.</summary>
+        <value>
+          <para />
+        </value>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Producer">
@@ -105,9 +127,11 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>The product that is converting this document to PDF.</summary>
+        <value>
+          <para />
+        </value>
+        <remarks>Leave empty to get the default, correct value.</remarks>
       </Docs>
     </Member>
     <Member MemberName="Subject">
@@ -121,9 +145,13 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>The subject of the document.</summary>
+        <value>
+          <para />
+        </value>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Title">
@@ -137,9 +165,13 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>The document’s title.</summary>
+        <value>
+          <para />
+        </value>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
   </Members>