more docs

mono · May 4, 2017 · 63284cd · 63284cd
1 parent 495b58c
commit 63284cd
Show file tree

Hide file tree

Showing 6 changed files with 112 additions and 66 deletions.
diff --git a/docs/en/SkiaSharp.HarfBuzz/BlobExtensions.xml b/docs/en/SkiaSharp.HarfBuzz/BlobExtensions.xml
@@ -10,8 +10,10 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>Various extension methods to integrate SkiaSharp and a HarfBuzz <see cref="T:HarfBuzzSharp.Blob" />.</summary>
+    <remarks>
+      <para></para>
+    </remarks>
   </Docs>
   <Members>
     <Member MemberName="ToHarfBuzzBlob">
@@ -28,10 +30,12 @@
         <Parameter Name="asset" Type="SkiaSharp.SKStreamAsset" RefType="this" />
       </Parameters>
       <Docs>
-        <param name="asset">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="asset">The stream to convert into a <see cref="T:HarfBuzzSharp.Blob" />.</param>
+        <summary>Converts a seekable stream into a <see cref="T:HarfBuzzSharp.Blob" />.</summary>
+        <returns>Returns the new <see cref="T:HarfBuzzSharp.Blob" /> instance.</returns>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
   </Members>

diff --git a/docs/en/SkiaSharp.HarfBuzz/CanvasExtensions.xml b/docs/en/SkiaSharp.HarfBuzz/CanvasExtensions.xml
@@ -10,8 +10,10 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>Various extension methods to integrate a SkiaSharp <see cref="T:SkiaSharp.SKCanvas" /> and HarfBuzz.</summary>
+    <remarks>
+      <para></para>
+    </remarks>
   </Docs>
   <Members>
     <Member MemberName="DrawShapedText">
@@ -33,14 +35,16 @@
         <Parameter Name="paint" Type="SkiaSharp.SKPaint" />
       </Parameters>
       <Docs>
-        <param name="canvas">To be added.</param>
-        <param name="shaper">To be added.</param>
-        <param name="text">To be added.</param>
-        <param name="x">To be added.</param>
-        <param name="y">To be added.</param>
-        <param name="paint">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="canvas">The canvas to draw on.</param>
+        <param name="shaper">The text shaper to use when shaping the text.</param>
+        <param name="text">The text to draw.</param>
+        <param name="x">The x-coordinate of the origin of the text being drawn.</param>
+        <param name="y">The y-coordinate of the origin of the text being drawn.</param>
+        <param name="paint">The paint to use when drawing the text.</param>
+        <summary>Draws shaped text on the canvas at the specified coordinates.</summary>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
   </Members>

diff --git a/docs/en/SkiaSharp.HarfBuzz/FontExtensions.xml b/docs/en/SkiaSharp.HarfBuzz/FontExtensions.xml
@@ -10,8 +10,10 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>Various extension methods to integrate SkiaSharp and a HarfBuzz <see cref="T:HarfBuzzSharp.Font" />.</summary>
+    <remarks>
+      <para></para>
+    </remarks>
   </Docs>
   <Members>
     <Member MemberName="GetScale">
@@ -28,10 +30,12 @@
         <Parameter Name="font" Type="HarfBuzzSharp.Font" RefType="this" />
       </Parameters>
       <Docs>
-        <param name="font">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="font">The font to retrieve the scale.</param>
+        <summary>Retrieves the font scale.</summary>
+        <returns>Returns the font scale.</returns>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="SetScale">
@@ -49,10 +53,12 @@
         <Parameter Name="scale" Type="SkiaSharp.SKSizeI" />
       </Parameters>
       <Docs>
-        <param name="font">To be added.</param>
-        <param name="scale">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="font">The font to set the scale.</param>
+        <param name="scale">The scale to set.</param>
+        <summary>Sets the font scale.</summary>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
   </Members>

diff --git a/docs/en/SkiaSharp.HarfBuzz/SKShaper+Result.xml b/docs/en/SkiaSharp.HarfBuzz/SKShaper+Result.xml
@@ -10,8 +10,10 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>Represents the result of a shaping operation.</summary>
+    <remarks>
+      <para></para>
+    </remarks>
   </Docs>
   <Members>
     <Member MemberName=".ctor">
@@ -23,8 +25,10 @@
       </AssemblyInfo>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <summary>Creates a new <see cref="T:SkiaSharp.HarfBuzz.SKShaper+Result" /> instance using empty values.</summary>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -40,11 +44,13 @@
         <Parameter Name="points" Type="SkiaSharp.SKPoint[]" />
       </Parameters>
       <Docs>
-        <param name="codepoints">To be added.</param>
-        <param name="clusters">To be added.</param>
-        <param name="points">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="codepoints">The glyph Unicode code points.</param>
+        <param name="clusters">The glyph clusters.</param>
+        <param name="points">The glyph positions.</param>
+        <summary>Creates a new <see cref="T:SkiaSharp.HarfBuzz.SKShaper+Result" /> instance using the specified values.</summary>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Clusters">
@@ -58,9 +64,13 @@
         <ReturnType>System.UInt32[]</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets the glyph clusters.</summary>
+        <value>
+          <para></para>
+        </value>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Codepoints">
@@ -74,9 +84,13 @@
         <ReturnType>System.Byte[]</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets the glyph Unicode code points.</summary>
+        <value>
+          <para></para>
+        </value>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Points">
@@ -90,9 +104,13 @@
         <ReturnType>SkiaSharp.SKPoint[]</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets the glyph positions.</summary>
+        <value>
+          <para></para>
+        </value>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
   </Members>

diff --git a/docs/en/SkiaSharp.HarfBuzz/SKShaper.xml b/docs/en/SkiaSharp.HarfBuzz/SKShaper.xml
@@ -14,8 +14,10 @@
     </Interface>
   </Interfaces>
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>Encapsulates basic text shaping.</summary>
+    <remarks>
+      <para></para>
+    </remarks>
   </Docs>
   <Members>
     <Member MemberName=".ctor">
@@ -29,9 +31,11 @@
         <Parameter Name="typeface" Type="SkiaSharp.SKTypeface" />
       </Parameters>
       <Docs>
-        <param name="typeface">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="typeface">The typeface to use for the text shaping.</param>
+        <summary>Creates a new <see cref="T:SkiaSharp.HarfBuzz.SKShaper" /> instance using the specified typeface.</summary>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Dispose">
@@ -65,11 +69,13 @@
         <Parameter Name="paint" Type="SkiaSharp.SKPaint" />
       </Parameters>
       <Docs>
-        <param name="text">To be added.</param>
-        <param name="paint">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="text">The text to shape.</param>
+        <param name="paint">The paint to use.</param>
+        <summary>Shapes the specified text using the properties from the paint.</summary>
+        <returns>Returns the results of the shaping operation.</returns>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Shape">
@@ -89,13 +95,15 @@
         <Parameter Name="paint" Type="SkiaSharp.SKPaint" />
       </Parameters>
       <Docs>
-        <param name="text">To be added.</param>
-        <param name="xOffset">To be added.</param>
-        <param name="yOffset">To be added.</param>
-        <param name="paint">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="text">The text to shape.</param>
+        <param name="xOffset">The x-offset to use when creating the shaping result.</param>
+        <param name="yOffset">The y-offset to use when creating the shaping result.</param>
+        <param name="paint">The paint to use.</param>
+        <summary>Shapes the specified text using the properties from the paint.</summary>
+        <returns>Returns the results of the shaping operation.</returns>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Typeface">
@@ -109,9 +117,13 @@
         <ReturnType>SkiaSharp.SKTypeface</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets the typeface used when creating the shaper.</summary>
+        <value>
+          <para />
+        </value>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
   </Members>

diff --git a/docs/en/ns-SkiaSharp.HarfBuzz.xml b/docs/en/ns-SkiaSharp.HarfBuzz.xml
@@ -1,6 +1,8 @@
 <Namespace Name="SkiaSharp.HarfBuzz">
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>The SkiaSharp.HarfBuzz namespace contains classes for shaping text for SkiaSharp using HarfBuzz.</summary>
+    <remarks>
+      <para />
+    </remarks>
   </Docs>
 </Namespace>