This commit is contained in:
Matthew Leibowitz 2017-03-27 22:08:48 +02:00
Родитель 39c06ec879
Коммит 1cc9af5adb
11 изменённых файлов: 160 добавлений и 132 удалений

Просмотреть файл

@ -633,10 +633,12 @@
<Parameter Name="stream" Type="System.IO.Stream" /> <Parameter Name="stream" Type="System.IO.Stream" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="stream">To be added.</param> <param name="stream">The stream to decode.</param>
<summary>To be added.</summary> <summary>Decode a bitmap using the specified stream and destination image information.</summary>
<returns>To be added.</returns> <returns>The the decoded bitmap, or <paramref name="null" /> on error.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Decode"> <Member MemberName="Decode">
@ -786,11 +788,13 @@
<Parameter Name="bitmapInfo" Type="SkiaSharp.SKImageInfo" /> <Parameter Name="bitmapInfo" Type="SkiaSharp.SKImageInfo" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="stream">To be added.</param> <param name="stream">The stream to decode.</param>
<param name="bitmapInfo">To be added.</param> <param name="bitmapInfo">The destination image information.</param>
<summary>To be added.</summary> <summary>Decode a bitmap using the specified stream and destination image information.</summary>
<returns>To be added.</returns> <returns>The the decoded bitmap, or <paramref name="null" /> on error.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Decode"> <Member MemberName="Decode">
@ -917,10 +921,12 @@
<Parameter Name="stream" Type="System.IO.Stream" /> <Parameter Name="stream" Type="System.IO.Stream" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="stream">To be added.</param> <param name="stream">The stream to decode.</param>
<summary>To be added.</summary> <summary>Decode the bitmap information using the specified stream.</summary>
<returns>To be added.</returns> <returns>The the decoded bitmap information, or <see cref="F:SkiaSharp.SKImageInfo.Empty" /> if there was an error.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DecodeBounds"> <Member MemberName="DecodeBounds">
@ -1022,12 +1028,14 @@
<Parameter Name="quality" Type="System.Int32" /> <Parameter Name="quality" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="dst">To be added.</param> <param name="dst">The stream to write the encoded image to.</param>
<param name="format">To be added.</param> <param name="format">The file format used to encode the image.</param>
<param name="quality">To be added.</param> <param name="quality">The quality level to use for the image.</param>
<summary>To be added.</summary> <summary>Encodes the image using the specified format.</summary>
<returns>To be added.</returns> <returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Erase"> <Member MemberName="Erase">
@ -1803,8 +1811,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Indicates to consumers of the bitmap that the pixel data has changed.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PeekPixels"> <Member MemberName="PeekPixels">
@ -1839,10 +1849,12 @@
<Parameter Name="pixmap" Type="SkiaSharp.SKPixmap" /> <Parameter Name="pixmap" Type="SkiaSharp.SKPixmap" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="pixmap">To be added.</param> <param name="pixmap">The pixmap to receive the pixel information.</param>
<summary>To be added.</summary> <summary>Returns the pixmap of the bitmap.</summary>
<returns>To be added.</returns> <returns>Returns <see langword="true" /> on success, or <see langword="false" /> if the bitmap does not have access to pixel data.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Pixels"> <Member MemberName="Pixels">

Просмотреть файл

@ -1575,12 +1575,14 @@
<Parameter Name="paint" Type="SkiaSharp.SKPaint" /> <Parameter Name="paint" Type="SkiaSharp.SKPaint" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="surface">To be added.</param> <param name="surface">The surface to draw.</param>
<param name="x">To be added.</param> <param name="x">The x-coordinate destination for the surface.</param>
<param name="y">To be added.</param> <param name="y">The y-coordinate destination for the surface.</param>
<param name="paint">To be added.</param> <param name="paint">The paint to use when drawing the surface, or <see langword="null" />.</param>
<summary>To be added.</summary> <summary>Draws a surface on the canvas.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawText"> <Member MemberName="DrawText">

Просмотреть файл

@ -49,9 +49,13 @@
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets or sets a value indicating whether the end marker for this frame is contained in the stream.</summary>
<value>To be added.</value> <value>
<remarks>To be added.</remarks> <para></para>
</value>
<remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RequiredFrame"> <Member MemberName="RequiredFrame">

Просмотреть файл

@ -210,10 +210,12 @@
<Parameter Name="size" Type="System.Int32" /> <Parameter Name="size" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="size">To be added.</param> <param name="size">The size of the data buffer to create.</param>
<summary>To be added.</summary> <summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with uninitialized data.</summary>
<returns>To be added.</returns> <summary>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Create"> <Member MemberName="Create">
@ -230,10 +232,12 @@
<Parameter Name="size" Type="System.UInt64" /> <Parameter Name="size" Type="System.UInt64" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="size">To be added.</param> <param name="size">The size of the data buffer to create.</param>
<summary>To be added.</summary> <summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with uninitialized data.</summary>
<returns>To be added.</returns> <summary>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Create"> <Member MemberName="Create">

Просмотреть файл

@ -224,11 +224,11 @@
<Parameter Name="dpi" Type="System.Single" /> <Parameter Name="dpi" Type="System.Single" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="stream">To be added.</param> <param name="stream">The stream to write to.</param>
<param name="dpi">To be added.</param> <param name="dpi">The DPI (pixels-per-inch) at which features without native XPS support will be rasterized.</param>
<summary>To be added.</summary> <summary>Create a XPS-backed document, writing the results into a stream.</summary>
<returns>To be added.</returns> <returns>Returns the new XPS-backed document.</returns>
<remarks>To be added.</remarks> <remarks>XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CreateXps"> <Member MemberName="CreateXps">
@ -246,11 +246,11 @@
<Parameter Name="dpi" Type="System.Single" /> <Parameter Name="dpi" Type="System.Single" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="path">To be added.</param> <param name="path">The path of the file to write to.</param>
<param name="dpi">To be added.</param> <param name="dpi">The DPI (pixels-per-inch) at which features without native XPS support will be rasterized.</param>
<summary>To be added.</summary> <summary>Create a XPS-backed document, writing the results into a stream.</summary>
<returns>To be added.</returns> <returns>Returns the new XPS-backed document.</returns>
<remarks>To be added.</remarks> <remarks>XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DefaultRasterDpi"> <Member MemberName="DefaultRasterDpi">

Просмотреть файл

@ -59,9 +59,11 @@
<Parameter Name="dst" Type="SkiaSharp.SKWStream" /> <Parameter Name="dst" Type="SkiaSharp.SKWStream" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="dst">To be added.</param> <param name="dst">The stream to copy the data into.</param>
<summary>To be added.</summary> <summary>Copies the data from the current stream into another stream.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CopyTo"> <Member MemberName="CopyTo">
@ -78,9 +80,11 @@
<Parameter Name="data" Type="System.IntPtr" /> <Parameter Name="data" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="data">To be added.</param> <param name="data">The memory location to copy the data to.</param>
<summary>To be added.</summary> <summary>Copies the data from the current stream to a memory location.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CopyToData"> <Member MemberName="CopyToData">
@ -119,9 +123,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Returns a <see cref="T:SkiaSharp.SKData" /> instance of the data in the current stream, and then resets the current stream.</summary>
<returns>To be added.</returns> <returns>Returns the <see cref="T:SkiaSharp.SKData" /> instance.</returns>
<remarks>To be added.</remarks> <remarks>After calling this method, this stream is reset to its empty state.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DetachAsStream"> <Member MemberName="DetachAsStream">

Просмотреть файл

@ -170,11 +170,13 @@
<Parameter Name="quality" Type="System.Int32" /> <Parameter Name="quality" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="format">To be added.</param> <param name="format">The file format used to encode the image.</param>
<param name="quality">To be added.</param> <param name="quality">The quality level to use for the image.</param>
<summary>To be added.</summary> <summary>Encodes the image using the specified format.</summary>
<returns>To be added.</returns> <returns>Returns the <see cref="T:SkiaSharp.SKData" /> wrapping the encoded image.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Encode"> <Member MemberName="Encode">
@ -1083,7 +1085,7 @@
<param name="srcX">The source x-coordinate to start reading from.</param> <param name="srcX">The source x-coordinate to start reading from.</param>
<param name="srcY">The source y-coordinate to start reading from.</param> <param name="srcY">The source y-coordinate to start reading from.</param>
<summary>Copies the pixels from the image into the specified buffer.</summary> <summary>Copies the pixels from the image into the specified buffer.</summary>
<returns>Returns <see langword="true" /> if the pexels were read, or <see langword="false" /> if there was an error.</returns> <returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
<remarks>This method may return <see langword="false" /> if the source rectangle [<paramref name="srcX" />, <paramref name="srcY" />, dstInfo.Width, dstInfo.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types.</remarks> <remarks>This method may return <see langword="false" /> if the source rectangle [<paramref name="srcX" />, <paramref name="srcY" />, dstInfo.Width, dstInfo.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types.</remarks>
</Docs> </Docs>
</Member> </Member>

Просмотреть файл

@ -176,11 +176,13 @@
<Parameter Name="quality" Type="System.Int32" /> <Parameter Name="quality" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="encoder">To be added.</param> <param name="encoder">The file format used to encode the pixmap.</param>
<param name="quality">To be added.</param> <param name="quality">The quality level to use for the pixmap.</param>
<summary>To be added.</summary> <summary>Encodes the pixmap using the specified format.</summary>
<returns>To be added.</returns> <returns>Returns the <see cref="T:SkiaSharp.SKData" /> wrapping the encoded pixmap.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Encode"> <Member MemberName="Encode">
@ -199,12 +201,14 @@
<Parameter Name="quality" Type="System.Int32" /> <Parameter Name="quality" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="dst">To be added.</param> <param name="dst">The stream to write the encoded pixmap to.</param>
<param name="encoder">To be added.</param> <param name="encoder">The file format used to encode the pixmap.</param>
<param name="quality">To be added.</param> <param name="quality">The quality level to use for the pixmap.</param>
<summary>To be added.</summary> <summary>Encodes the pixmap using the specified format.</summary>
<returns>To be added.</returns> <returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Encode"> <Member MemberName="Encode">
@ -224,13 +228,15 @@
<Parameter Name="quality" Type="System.Int32" /> <Parameter Name="quality" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="dst">To be added.</param> <param name="dst">The stream to write the encoded pixmap to.</param>
<param name="src">To be added.</param> <param name="src">The pixmap to encode.</param>
<param name="encoder">To be added.</param> <param name="encoder">The file format used to encode the pixmap.</param>
<param name="quality">To be added.</param> <param name="quality">The quality level to use for the pixmap.</param>
<summary>To be added.</summary> <summary>Encodes the pixmap using the specified format.</summary>
<returns>To be added.</returns> <returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetPixels"> <Member MemberName="GetPixels">

Просмотреть файл

@ -670,12 +670,14 @@
<Parameter Name="paint" Type="SkiaSharp.SKPaint" /> <Parameter Name="paint" Type="SkiaSharp.SKPaint" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="canvas">To be added.</param> <param name="canvas">The canvas to draw on.</param>
<param name="x">To be added.</param> <param name="x">The x-coordinate destination for the surface.</param>
<param name="y">To be added.</param> <param name="y">The y-coordinate destination for the surface.</param>
<param name="paint">To be added.</param> <param name="paint">The paint to use when drawing the surface, or <see langword="null" />.</param>
<summary>To be added.</summary> <summary>Draws the current surface on the specified canvas.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PeekPixels"> <Member MemberName="PeekPixels">
@ -690,9 +692,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Returns the pixels, if they are available.</summary>
<returns>To be added.</returns> <returns>Returns the pixels, if they are available, otherwise <see langword="null" />.</returns>
<remarks>To be added.</remarks> <remarks>If the pixels are available, then the surface is only valid until the surface changes in any way, in which case the pixmap becomes invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PeekPixels"> <Member MemberName="PeekPixels">
@ -709,10 +711,12 @@
<Parameter Name="pixmap" Type="SkiaSharp.SKPixmap" /> <Parameter Name="pixmap" Type="SkiaSharp.SKPixmap" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="pixmap">To be added.</param> <param name="pixmap">The pixmap to receive the pixel information.</param>
<summary>To be added.</summary> <summary>Returns the pixmap of the surface.</summary>
<returns>To be added.</returns> <returns>Returns <see langword="true" /> on success, or <see langword="false" /> if the surface does not have access to pixel data.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ReadPixels"> <Member MemberName="ReadPixels">
@ -733,14 +737,14 @@
<Parameter Name="srcY" Type="System.Int32" /> <Parameter Name="srcY" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="dstInfo">To be added.</param> <param name="dstInfo">The image information describing the destination pixel buffer.</param>
<param name="dstPixels">To be added.</param> <param name="dstPixels">The pixel buffer to read the pixel data into.</param>
<param name="dstRowBytes">To be added.</param> <param name="dstRowBytes">The number of bytes in each row of in the destination buffer.</param>
<param name="srcX">To be added.</param> <param name="srcX">The source x-coordinate to start reading from.</param>
<param name="srcY">To be added.</param> <param name="srcY">The source y-coordinate to start reading from.</param>
<summary>To be added.</summary> <summary>Copies the pixels from the surface into the specified buffer.</summary>
<returns>To be added.</returns> <returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
<remarks>To be added.</remarks> <remarks>This method may return <see langword="false" /> if the source rectangle [<paramref name="srcX" />, <paramref name="srcY" />, dstInfo.Width, dstInfo.Height] does not intersect the surface, or if the color type/alpha type could not be converted to the destination types.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Snapshot"> <Member MemberName="Snapshot">
@ -785,9 +789,13 @@
<ReturnType>SkiaSharp.SKSurfaceProps</ReturnType> <ReturnType>SkiaSharp.SKSurfaceProps</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets the surface property configuration.</summary>
<value>To be added.</value> <value>
<remarks>To be added.</remarks> <para></para>
</value>
<remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

Просмотреть файл

@ -459,11 +459,13 @@ using (var tf = SKTypeface.FromStream (stream)) {
<Parameter Name="index" Type="System.Int32" /> <Parameter Name="index" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="stream">To be added.</param> <param name="stream">The input stream.</param>
<param name="index">To be added.</param> <param name="index">The font face index.</param>
<summary>To be added.</summary> <summary>Returns a new typeface given a stream. Ownership of the stream is transferred, so the caller must not reference it again.</summary>
<returns>To be added.</returns> <returns>Returns a new typeface, or <paramref name="null" /> if the file does not exist, or is not a valid font file.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FromTypeface"> <Member MemberName="FromTypeface">

Просмотреть файл

@ -108,23 +108,6 @@
<MemberSignature Language="C#" Value="public bool NewLine ();" /> <MemberSignature Language="C#" Value="public bool NewLine ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool NewLine() cil managed" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool NewLine() cil managed" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.57.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NewLine">
<MemberSignature Language="C#" Value="public void NewLine ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void NewLine() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo> <AssemblyInfo>
<AssemblyVersion>1.49.0.0</AssemblyVersion> <AssemblyVersion>1.49.0.0</AssemblyVersion>
<AssemblyVersion>1.52.0.0</AssemblyVersion> <AssemblyVersion>1.52.0.0</AssemblyVersion>
@ -133,9 +116,10 @@
<AssemblyVersion>1.54.0.0</AssemblyVersion> <AssemblyVersion>1.54.0.0</AssemblyVersion>
<AssemblyVersion>1.55.0.0</AssemblyVersion> <AssemblyVersion>1.55.0.0</AssemblyVersion>
<AssemblyVersion>1.56.0.0</AssemblyVersion> <AssemblyVersion>1.56.0.0</AssemblyVersion>
<AssemblyVersion>1.57.0.0</AssemblyVersion>
</AssemblyInfo> </AssemblyInfo>
<ReturnValue> <ReturnValue>
<ReturnType>System.Void</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>