Skip to content

Fill API documentation placeholders #81

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
github-actions merged 14 commits into from
May 11, 2026
Merged

Fill API documentation placeholders #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
242625a
Fill API documentation placeholders
github-actions[bot] May 11, 2026
91c9fde
Update Face.xml
mattleibow May 11, 2026
8701264
Update Face.xml
mattleibow May 11, 2026
b2fc4b9
Update Face.xml
mattleibow May 11, 2026
30b4cc9
Update Face.xml
mattleibow May 11, 2026
f24149a
Update Face.xml
mattleibow May 11, 2026
be054ad
Update Face.xml
mattleibow May 11, 2026
82f7881
Update Face.xml
mattleibow May 11, 2026
ca502f7
Update Face.xml
mattleibow May 11, 2026
5eee011
Merge branch 'main' into automation/write-api-docs
mattleibow May 11, 2026
c6fe7cf
Update GTKExtensions.xml
mattleibow May 11, 2026
0ac821f
Update GTKExtensions.xml
mattleibow May 11, 2026
80e6f7e
Update Face.xml
mattleibow May 11, 2026
bcea51d
Merge branch 'main' into automation/write-api-docs
mattleibow May 11, 2026
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
162 changes: 84 additions & 78 deletions SkiaSharpAPI/HarfBuzzSharp/Face.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,10 @@
<Parameter Name="instanceIndex" Type="System.Int32" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="instanceIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="instanceIndex">The zero-based index of the named instance.</param>
<summary>Returns the design coordinates for the specified named instance.</summary>
<returns>An array of design coordinate values for the named instance.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetNamedInstanceDesignCoords">
Expand All @@ -190,11 +190,11 @@
<Parameter Name="coords" Type="System.Span&lt;System.Single&gt;" Index="1" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="instanceIndex">To be added.</param>
<param name="coords">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="instanceIndex">The zero-based index of the named instance.</param>
<param name="coords">The span to fill with design coordinate values.</param>
<summary>Fills the specified span with the design coordinates for the given named instance.</summary>
<returns>The number of coordinates written to the span.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetNamedInstanceDesignCoordsCount">
Expand All @@ -213,10 +213,10 @@
<Parameter Name="instanceIndex" Type="System.Int32" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="instanceIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="instanceIndex">The zero-based index of the named instance.</param>
<summary>Returns the number of design coordinates for the specified named instance.</summary>
<returns>The number of design coordinates.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetNamedInstancePostScriptNameId">
Expand All @@ -235,10 +235,10 @@
<Parameter Name="instanceIndex" Type="System.Int32" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="instanceIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="instanceIndex">The zero-based index of the named instance.</param>
<summary>Returns the name ID of the PostScript name for the specified named instance.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> of the PostScript name.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetNamedInstanceSubfamilyNameId">
Expand All @@ -257,10 +257,10 @@
<Parameter Name="instanceIndex" Type="System.Int32" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="instanceIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="instanceIndex">The zero-based index of the named instance.</param>
<summary>Returns the name ID of the subfamily name for the specified named instance.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> of the subfamily name.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetPaletteColorNameId">
Expand All @@ -279,10 +279,10 @@
<Parameter Name="colorIndex" Type="System.Int32" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="colorIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="colorIndex">The zero-based index of the palette color entry.</param>
<summary>Returns the name ID for the color at the specified index across all palettes.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> of the color entry.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetPaletteColors">
Expand All @@ -301,10 +301,10 @@
<Parameter Name="paletteIndex" Type="System.Int32" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="paletteIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="paletteIndex">The zero-based index of the palette.</param>
<summary>Returns the ARGB color values for the specified palette.</summary>
<returns>An array of packed ARGB color values.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetPaletteColors">
Expand All @@ -324,11 +324,11 @@
<Parameter Name="colors" Type="System.Span&lt;System.UInt32&gt;" Index="1" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="paletteIndex">To be added.</param>
<param name="colors">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="paletteIndex">The zero-based index of the palette.</param>
<param name="colors">The span to fill with packed ARGB color values.</param>
<summary>Fills the specified span with the ARGB color values for the given palette.</summary>
<returns>The number of colors written to the span.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetPaletteFlags">
Expand All @@ -347,10 +347,10 @@
<Parameter Name="paletteIndex" Type="System.Int32" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="paletteIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="paletteIndex">The zero-based index of the palette.</param>
<summary>Returns the flags for the specified color palette.</summary>
<returns>A bitwise combination of <see cref="T:HarfBuzzSharp.OpenTypeColorPaletteFlags" /> values describing the palette.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetPaletteNameId">
Expand All @@ -369,10 +369,10 @@
<Parameter Name="paletteIndex" Type="System.Int32" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="paletteIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="paletteIndex">The zero-based index of the palette.</param>
<summary>Returns the name ID for the specified color palette.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> of the palette.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetVariationAxisInfos">
Expand All @@ -391,10 +391,10 @@
<Parameter Name="axes" Type="System.Span&lt;HarfBuzzSharp.OpenTypeVarAxisInfo&gt;" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="axes">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="axes">The span to fill with variation axis information.</param>
<summary>Fills the specified span with variation axis information for this face.</summary>
<returns>The number of variation axes written to the span.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GlyphCount">
Expand Down Expand Up @@ -428,9 +428,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value indicating whether this face contains color layer data (COLR table).</summary>
<value>
<see langword="true" /> if the face has color layers; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HasColorPng">
Expand All @@ -446,9 +447,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value indicating whether this face contains PNG-based color glyphs.</summary>
<value>
<see langword="true" /> if the face has PNG color glyphs; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HasColorSvg">
Expand All @@ -464,9 +466,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value indicating whether this face contains SVG-based color glyphs.</summary>
<value>
<see langword="true" /> if the face has SVG color glyphs; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HasPalettes">
Expand All @@ -482,9 +485,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value indicating whether this face contains color palettes (CPAL table).</summary>
<value>
<see langword="true" /> if the face has color palettes; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HasVariationData">
Expand All @@ -500,9 +504,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value indicating whether this face contains variable font data.</summary>
<value>
<see langword="true" /> if the face is a variable font; otherwise, <see langword="false" />.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Index">
Expand Down Expand Up @@ -573,9 +578,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the number of named variation instances defined in this face.</summary>
<value>The number of named instances.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PaletteCount">
Expand All @@ -591,9 +596,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the number of color palettes defined in this face.</summary>
<value>The number of color palettes.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ReferenceTable">
Expand Down Expand Up @@ -653,11 +658,12 @@
<Parameter Name="axisInfo" Type="HarfBuzzSharp.OpenTypeVarAxisInfo" RefType="out" Index="1" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="tag">To be added.</param>
<param name="axisInfo">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="tag">The 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>Searches for a variation axis by its tag.</summary>
<returns>
<see langword="true" /> if the axis was found; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="UnitsPerEm">
Expand Down Expand Up @@ -691,9 +697,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the number of variation axes defined in this face.</summary>
<value>The number of variation axes.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="VariationAxisInfos">
Expand All @@ -709,9 +715,9 @@
<ReturnType>HarfBuzzSharp.OpenTypeVarAxisInfo[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the variation axis information for all axes defined in this face.</summary>
<value>An array of <see cref="T:HarfBuzzSharp.OpenTypeVarAxisInfo" /> describing each variation axis.</value>
<remarks></remarks>
</Docs>
</Member>
</Members>
Expand Down
38 changes: 19 additions & 19 deletions SkiaSharpAPI/HarfBuzzSharp/Font.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,10 +321,10 @@
<Parameter Name="coords" Type="System.Span&lt;System.Int32&gt;" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="coords">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="coords">The span to fill with normalized variation coordinate values.</param>
<summary>Fills the specified span with the current normalized variation coordinates for this font.</summary>
<returns>The number of coordinates written to the span.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetVerticalGlyphAdvance">
Expand Down Expand Up @@ -579,9 +579,9 @@
<Parameter Name="coords" Type="System.ReadOnlySpan&lt;System.Single&gt;" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="coords">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="coords">The design coordinate values, one per variation axis.</param>
<summary>Sets the variation design coordinates for this font.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetVariationCoordsNormalized">
Expand All @@ -600,9 +600,9 @@
<Parameter Name="coords" Type="System.ReadOnlySpan&lt;System.Int32&gt;" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="coords">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="coords">The normalized coordinate values in the range [-1, 1], one per variation axis.</param>
<summary>Sets the normalized variation coordinates for this font.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetVariationNamedInstance">
Expand All @@ -621,9 +621,9 @@
<Parameter Name="instanceIndex" Type="System.Int32" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="instanceIndex">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="instanceIndex">The zero-based index of the named instance to activate.</param>
<summary>Sets the variation coordinates to match the specified named instance.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetVariations">
Expand All @@ -642,9 +642,9 @@
<Parameter Name="variations" Type="System.ReadOnlySpan&lt;HarfBuzzSharp.Variation&gt;" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="variations">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="variations">The tag-value pairs specifying the variation axis values to apply.</param>
<summary>Sets the variation axis values for this font.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Shape">
Expand Down Expand Up @@ -1250,9 +1250,9 @@
<ReturnType>System.Int32[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the current normalized variation coordinates for this font.</summary>
<value>An array of normalized variation coordinate values in the range [-1, 1].</value>
<remarks></remarks>
</Docs>
</Member>
</Members>
Expand Down
4 changes: 2 additions & 2 deletions SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,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>
</Members>
Expand Down
Loading