Skip to content

Fill API documentation placeholders #151

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

Merged
mattleibow merged 1 commit into from
Jun 23, 2026
Merged

Fill API documentation placeholders #151

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
18 changes: 12 additions & 6 deletions SkiaSharpAPI/HarfBuzzSharp/Face.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,8 @@
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the font face contains a COLR color-layers table.</summary>
<value><see langword="true" /> if the face contains a COLR color-layers table; otherwise, <see langword="false" />.</value>
<value>
<see langword="true" /> if the face contains a COLR color-layers table; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -447,7 +448,8 @@
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the font face contains a PNG color-bitmap table.</summary>
<value><see langword="true" /> if the face contains a CBDT/CBLC PNG color-bitmap table; otherwise, <see langword="false" />.</value>
<value>
<see langword="true" /> if the face contains a CBDT/CBLC PNG color-bitmap table; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -465,7 +467,8 @@
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the font face contains an SVG color table.</summary>
<value><see langword="true" /> if the face contains an SVG color table; otherwise, <see langword="false" />.</value>
<value>
<see langword="true" /> if the face contains an SVG color table; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -483,7 +486,8 @@
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the font face contains a CPAL color-palette table.</summary>
<value><see langword="true" /> if the face contains a CPAL color-palette table; otherwise, <see langword="false" />.</value>
<value>
<see langword="true" /> if the face contains a CPAL color-palette table; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -501,7 +505,8 @@
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the font face contains OpenType variation data.</summary>
<value><see langword="true" /> if the face contains OpenType variation data (fvar table); otherwise, <see langword="false" />.</value>
<value>
<see langword="true" /> if the face contains OpenType variation data (fvar table); otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -656,7 +661,8 @@
<param name="tag">The four-byte OpenType tag of the variation axis to find.</param>
<param name="axisInfo">When this method returns, contains the axis information if found. This parameter is treated as uninitialized.</param>
<summary>Attempts to find information about the variation axis with the specified tag.</summary>
<returns><see langword="true" /> if the axis was found; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if the axis was found; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand Down
33 changes: 18 additions & 15 deletions SkiaSharpAPI/HarfBuzzSharp/HBColor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,8 @@ Console.WriteLine(red); // #FFFF0000
<Docs>
<param name="other">The <see cref="T:HarfBuzzSharp.HBColor" /> to compare with this instance.</param>
<summary>Indicates whether this color is equal to another <see cref="T:HarfBuzzSharp.HBColor" />.</summary>
<returns><see langword="true" /> if the two colors have the same packed value; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if the two colors have the same packed value; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -162,10 +163,10 @@ Console.WriteLine(red); // #FFFF0000
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="obj">The object to compare with the current color.</param>
<summary>Determines whether the specified object is equal to the current color.</summary>
<returns><see langword="true" /> if the specified object is equal to the current color; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
Expand Down Expand Up @@ -225,7 +226,8 @@ Console.WriteLine(red); // #FFFF0000
<param name="left">The first <see cref="T:HarfBuzzSharp.HBColor" /> to compare.</param>
<param name="right">The second <see cref="T:HarfBuzzSharp.HBColor" /> to compare.</param>
<summary>Determines whether two <see cref="T:HarfBuzzSharp.HBColor" /> values are equal.</summary>
<returns><see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> have the same packed value; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> have the same packed value; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -245,10 +247,10 @@ Console.WriteLine(red); // #FFFF0000
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="value">The packed BGRA integer value to convert.</param>
<summary>Explicitly converts a packed BGRA integer value to an <see cref="T:HarfBuzzSharp.HBColor" />.</summary>
<returns>An <see cref="T:HarfBuzzSharp.HBColor" /> with the specified packed value.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="op_Implicit">
Expand All @@ -267,10 +269,10 @@ Console.WriteLine(red); // #FFFF0000
<Parameter Name="color" Type="HarfBuzzSharp.HBColor" />
</Parameters>
<Docs>
<param name="color">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="color">The <see cref="T:HarfBuzzSharp.HBColor" /> to convert.</param>
<summary>Implicitly converts an <see cref="T:HarfBuzzSharp.HBColor" /> to a packed BGRA integer value.</summary>
<returns>The packed BGRA integer value of the color.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="op_Inequality">
Expand All @@ -293,7 +295,8 @@ Console.WriteLine(red); // #FFFF0000
<param name="left">The first <see cref="T:HarfBuzzSharp.HBColor" /> to compare.</param>
<param name="right">The second <see cref="T:HarfBuzzSharp.HBColor" /> to compare.</param>
<summary>Determines whether two <see cref="T:HarfBuzzSharp.HBColor" /> values are not equal.</summary>
<returns><see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> have different packed values; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> have different packed values; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 deletions SkiaSharpAPI/SkiaSharp.Views.Android/SKGLSurfaceViewRenderer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="OnDrawFrame">
Expand Down
7 changes: 4 additions & 3 deletions SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Releases the resources used by the current instance of the <see cref="T:SkiaSharp.Views.Gtk.SKDrawingArea" /> class.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
Expand All @@ -97,7 +97,8 @@
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing"><see langword="true" /> to release both managed and native resources; <see langword="false" /> to release only native resources.</param>
<param name="disposing">
<see langword="true" /> to release both managed and native resources; <see langword="false" /> to release only native resources.</param>
<summary>Releases the resources used by this <see cref="T:SkiaSharp.Views.Gtk.SKDrawingArea" />.</summary>
<remarks></remarks>
</Docs>
Expand Down
12 changes: 8 additions & 4 deletions SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ var components = new GRVkYcbcrComponents
<Docs>
<param name="obj">The <see cref="T:SkiaSharp.GRVkYcbcrComponents" /> to compare with this instance.</param>
<summary>Indicates whether this component mapping is equal to another <see cref="T:SkiaSharp.GRVkYcbcrComponents" />.</summary>
<returns><see langword="true" /> if both instances have identical component swizzle values; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if both instances have identical component swizzle values; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -138,7 +139,8 @@ var components = new GRVkYcbcrComponents
<Docs>
<param name="obj">The object to compare with this instance.</param>
<summary>Indicates whether this component mapping is equal to the specified object.</summary>
<returns><see langword="true" /> if <paramref name="obj" /> is a <see cref="T:SkiaSharp.GRVkYcbcrComponents" /> with identical component swizzle values; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if <paramref name="obj" /> is a <see cref="T:SkiaSharp.GRVkYcbcrComponents" /> with identical component swizzle values; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -209,7 +211,8 @@ var components = new GRVkYcbcrComponents
<param name="left">The first <see cref="T:SkiaSharp.GRVkYcbcrComponents" /> to compare.</param>
<param name="right">The second <see cref="T:SkiaSharp.GRVkYcbcrComponents" /> to compare.</param>
<summary>Determines whether two <see cref="T:SkiaSharp.GRVkYcbcrComponents" /> values are equal.</summary>
<returns><see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are equal; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are equal; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -233,7 +236,8 @@ var components = new GRVkYcbcrComponents
<param name="left">The first <see cref="T:SkiaSharp.GRVkYcbcrComponents" /> to compare.</param>
<param name="right">The second <see cref="T:SkiaSharp.GRVkYcbcrComponents" /> to compare.</param>
<summary>Determines whether two <see cref="T:SkiaSharp.GRVkYcbcrComponents" /> values are not equal.</summary>
<returns><see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are not equal; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are not equal; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand Down
21 changes: 14 additions & 7 deletions SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,8 @@ var conversionInfo = new GRVkYcbcrConversionInfo
<Docs>
<param name="obj">The <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> to compare with this instance.</param>
<summary>Indicates whether this conversion info is equal to another <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" />.</summary>
<returns><see langword="true" /> if both instances have identical conversion parameters; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if both instances have identical conversion parameters; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -142,7 +143,8 @@ var conversionInfo = new GRVkYcbcrConversionInfo
<Docs>
<param name="obj">The object to compare with this instance.</param>
<summary>Indicates whether this conversion info is equal to the specified object.</summary>
<returns><see langword="true" /> if <paramref name="obj" /> is a <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> with identical conversion parameters; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if <paramref name="obj" /> is a <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> with identical conversion parameters; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -188,7 +190,8 @@ var conversionInfo = new GRVkYcbcrConversionInfo
</ReturnValue>
<Docs>
<summary>Gets or sets whether explicit chroma reconstruction is required.</summary>
<value><c>1</c> to require explicit chroma reconstruction; <c>0</c> to allow implicit reconstruction.</value>
<value>
<c>1</c> to require explicit chroma reconstruction; <c>0</c> to allow implicit reconstruction.</value>
<remarks></remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -259,7 +262,8 @@ var conversionInfo = new GRVkYcbcrConversionInfo
<param name="left">The first <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> to compare.</param>
<param name="right">The second <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> to compare.</param>
<summary>Determines whether two <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> values are equal.</summary>
<returns><see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are equal; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are equal; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -283,7 +287,8 @@ var conversionInfo = new GRVkYcbcrConversionInfo
<param name="left">The first <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> to compare.</param>
<param name="right">The second <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> to compare.</param>
<summary>Determines whether two <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> values are not equal.</summary>
<returns><see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are not equal; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are not equal; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -306,7 +311,8 @@ var conversionInfo = new GRVkYcbcrConversionInfo
</ReturnValue>
<Docs>
<summary>Gets or sets whether the sampler filter must match the chroma reconstruction filter.</summary>
<value><see langword="true" /> if the sampler filter must match the chroma filter; otherwise, <see langword="false" />.</value>
<value>
<see langword="true" /> if the sampler filter must match the chroma filter; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
Expand All @@ -329,7 +335,8 @@ var conversionInfo = new GRVkYcbcrConversionInfo
</ReturnValue>
<Docs>
<summary>Gets or sets whether linear filtering is supported for this YCbCr conversion.</summary>
<value><see langword="true" /> if linear filtering is supported for this YCbCr conversion; otherwise, <see langword="false" />.</value>
<value>
<see langword="true" /> if linear filtering is supported for this YCbCr conversion; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
Expand Down
34 changes: 17 additions & 17 deletions SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@
<ReturnType>SkiaSharp.GRVkYcbcrComponents</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets the Vulkan YCbCr component swizzle mapping.</summary>
<value>A <see cref="T:SkiaSharp.GRVkYcbcrComponents" /> value that describes the component swizzle.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ExternalFormat">
Expand Down Expand Up @@ -177,10 +177,10 @@
<Parameter Name="value" Type="SkiaSharp.GrVkYcbcrConversionInfo" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="value">The <see cref="T:SkiaSharp.GrVkYcbcrConversionInfo" /> to convert.</param>
<summary>Implicitly converts a <see cref="T:SkiaSharp.GrVkYcbcrConversionInfo" /> to a <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" />.</summary>
<returns>A <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> that represents the same Vulkan YCbCr conversion parameters.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="op_Implicit">
Expand All @@ -199,10 +199,10 @@
<Parameter Name="value" Type="SkiaSharp.GRVkYcbcrConversionInfo" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="value">The <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> to convert.</param>
<summary>Implicitly converts a <see cref="T:SkiaSharp.GRVkYcbcrConversionInfo" /> to a <see cref="T:SkiaSharp.GrVkYcbcrConversionInfo" />.</summary>
<returns>A <see cref="T:SkiaSharp.GrVkYcbcrConversionInfo" /> that represents the same Vulkan YCbCr conversion parameters.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SamplerFilterMustMatchChromaFilter">
Expand All @@ -223,9 +223,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets a value indicating whether the sampler filter must match the chroma filter.</summary>
<value><see langword="true" /> if the sampler filter must match the chroma filter; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SupportsLinearFilter">
Expand All @@ -246,9 +246,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets a value indicating whether the image format supports linear filtering.</summary>
<value><see langword="true" /> if the image format supports linear filtering; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="XChromaOffset">
Expand Down
Loading