Skip to content

Fill and review API documentation #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fill and review API documentation #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions SkiaSharpAPI/HarfBuzzSharp/Tag.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,28 @@
<remarks />
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public static HarfBuzzSharp.Tag Parse (ReadOnlySpan&lt;char&gt; tag);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype HarfBuzzSharp.Tag Parse(valuetype System.ReadOnlySpan`1&lt;char&gt; tag) cil managed" />
<MemberSignature Language="DocId" Value="M:HarfBuzzSharp.Tag.Parse(System.ReadOnlySpan{System.Char})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>HarfBuzzSharp.Tag</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="tag" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="tag">The ISO 15924 tag to parse, as a span of characters.</param>
<summary>Parses the ISO 15924 tag into the corresponding <see cref="T:HarfBuzzSharp.Tag" />.</summary>
<returns>Returns the <see cref="T:HarfBuzzSharp.Tag" /> that corresponds the tag that was parsed.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public static HarfBuzzSharp.Tag Parse (string tag);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype HarfBuzzSharp.Tag Parse(string tag) cil managed" />
Expand Down
103 changes: 75 additions & 28 deletions SkiaSharpAPI/SkiaSharp/SKColor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<TypeSignature Language="DocId" Value="T:SkiaSharp.SKColor" />
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
Expand All @@ -31,7 +31,7 @@
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="value" Type="System.UInt32" />
Expand All @@ -49,7 +49,7 @@
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="red" Type="System.Byte" />
Expand All @@ -71,7 +71,7 @@
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="red" Type="System.Byte" />
Expand All @@ -95,7 +95,7 @@
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
Expand All @@ -113,7 +113,7 @@
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
Expand All @@ -131,7 +131,7 @@
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColor</ReturnType>
Expand All @@ -151,7 +151,7 @@
</Implements>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
Expand All @@ -173,7 +173,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
Expand All @@ -195,7 +195,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColor</ReturnType>
Expand Down Expand Up @@ -223,7 +223,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColor</ReturnType>
Expand Down Expand Up @@ -251,7 +251,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
Expand All @@ -270,7 +270,7 @@
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
Expand All @@ -288,7 +288,7 @@
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
Expand All @@ -306,7 +306,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
Expand All @@ -330,7 +330,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
Expand All @@ -352,7 +352,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColor</ReturnType>
Expand All @@ -374,7 +374,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
Expand All @@ -391,14 +391,36 @@
<remarks />
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKColor Parse (ReadOnlySpan&lt;char&gt; hexString);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype SkiaSharp.SKColor Parse(valuetype System.ReadOnlySpan`1&lt;char&gt; hexString) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKColor.Parse(System.ReadOnlySpan{System.Char})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColor</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hexString" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="hexString">The hexadecimal string representation of a color.</param>
<summary>Converts the hexadecimal string representation of a color to its <see cref="T:SkiaSharp.SKColor" /> equivalent.</summary>
<returns>The new <see cref="T:SkiaSharp.SKColor" /> instance.</returns>
<remarks>This method can parse a string in the forms with or without a preceding '#' character: AARRGGB, RRGGBB, ARGB, RGB.</remarks>
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKColor Parse (string hexString);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype SkiaSharp.SKColor Parse(string hexString) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKColor.Parse(System.String)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColor</ReturnType>
Expand All @@ -420,7 +442,7 @@
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
Expand All @@ -438,7 +460,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -463,7 +485,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -488,7 +510,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
Expand All @@ -500,14 +522,39 @@
<remarks />
</Docs>
</Member>
<Member MemberName="TryParse">
<MemberSignature Language="C#" Value="public static bool TryParse (ReadOnlySpan&lt;char&gt; hexString, out SkiaSharp.SKColor color);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryParse(valuetype System.ReadOnlySpan`1&lt;char&gt; hexString, [out] valuetype SkiaSharp.SKColor&amp; color) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKColor.TryParse(System.ReadOnlySpan{System.Char},SkiaSharp.SKColor@)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hexString" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
<Parameter Name="color" Type="SkiaSharp.SKColor" RefType="out" />
</Parameters>
<Docs>
<param name="hexString">The hexadecimal string representation of a color.</param>
<param name="color">The new <see cref="T:SkiaSharp.SKColor" /> instance.</param>
<summary>Converts the hexadecimal string representation of a color to its <see cref="T:SkiaSharp.SKColor" /> equivalent.</summary>
<returns>
<see langword="true" /> if the conversion was successful; otherwise, <see langword="false" />.</returns>
<remarks>This method can parse a string in the forms with or without a preceding '#' character: AARRGGB, RRGGBB, ARGB, RGB.</remarks>
</Docs>
</Member>
<Member MemberName="TryParse">
<MemberSignature Language="C#" Value="public static bool TryParse (string hexString, out SkiaSharp.SKColor color);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryParse(string hexString, [out] valuetype SkiaSharp.SKColor&amp; color) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKColor.TryParse(System.String,SkiaSharp.SKColor@)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
Expand All @@ -532,7 +579,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColor</ReturnType>
Expand All @@ -554,7 +601,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColor</ReturnType>
Expand All @@ -576,7 +623,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColor</ReturnType>
Expand All @@ -598,7 +645,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColor</ReturnType>
Expand Down
Loading