Skip to content

Fill API documentation placeholders #150

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 2 commits into from
Jun 23, 2026
Merged

Fill API documentation placeholders #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c57e286
docs: fill placeholder documentation for SkiaSharp and HarfBuzzSharp …
github-actions[bot] Jun 23, 2026
bcc11fe
Format and clean up documentation XML files
github-actions[bot] Jun 23, 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
159 changes: 0 additions & 159 deletions SkiaSharpAPI/FrameworksIndex/skiasharp.xml
View file
Open in desktop

Large diffs are not rendered by default.

156 changes: 78 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" />
</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-space coordinates for the specified named instance.</summary>
<returns>An array of design-space coordinate values for the named instance, one per variation axis.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetNamedInstanceDesignCoords">
Expand All @@ -190,11 +190,11 @@
<Parameter Name="coords" Type="System.Span&lt;System.Single&gt;" />
</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">A span to receive the design-space coordinate values.</param>
<summary>Fills a span with the design-space coordinates for the specified named instance.</summary>
<returns>The number of design-space coordinates written to <paramref name="coords" />.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetNamedInstanceDesignCoordsCount">
Expand All @@ -213,10 +213,10 @@
<Parameter Name="instanceIndex" Type="System.Int32" />
</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-space coordinates for the specified named instance.</summary>
<returns>The number of design-space coordinates for the named instance.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetNamedInstancePostScriptNameId">
Expand All @@ -235,10 +235,10 @@
<Parameter Name="instanceIndex" Type="System.Int32" />
</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 OpenType name ID of the PostScript name for the specified named instance.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> of the PostScript name string for the named instance.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetNamedInstanceSubfamilyNameId">
Expand All @@ -257,10 +257,10 @@
<Parameter Name="instanceIndex" Type="System.Int32" />
</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 OpenType name ID of the subfamily name for the specified named instance.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> of the subfamily name string for the named instance.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetPaletteColorNameId">
Expand All @@ -279,10 +279,10 @@
<Parameter Name="colorIndex" Type="System.Int32" />
</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 color entry within the palette.</param>
<summary>Returns the OpenType name ID of the name string for the specified palette color entry.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> of the color-entry name string.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetPaletteColors">
Expand All @@ -301,10 +301,10 @@
<Parameter Name="paletteIndex" Type="System.Int32" />
</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 all color entries for the specified font palette.</summary>
<returns>An array of <see cref="T:HarfBuzzSharp.HBColor" /> values for the palette, in BGRA byte order.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetPaletteColors">
Expand All @@ -324,11 +324,11 @@
<Parameter Name="colors" Type="System.Span&lt;HarfBuzzSharp.HBColor&gt;" />
</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">A span to receive the <see cref="T:HarfBuzzSharp.HBColor" /> values.</param>
<summary>Fills a span with the color entries for the specified font palette.</summary>
<returns>The number of color entries written to <paramref name="colors" />.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetPaletteFlags">
Expand All @@ -347,10 +347,10 @@
<Parameter Name="paletteIndex" Type="System.Int32" />
</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 font 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" />
</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 OpenType name ID of the name string for the specified palette.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> of the palette name string.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetVariationAxisInfos">
Expand All @@ -391,10 +391,10 @@
<Parameter Name="axes" Type="System.Span&lt;HarfBuzzSharp.OpenTypeVarAxisInfo&gt;" />
</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">A span to receive the <see cref="T:HarfBuzzSharp.OpenTypeVarAxisInfo" /> values.</param>
<summary>Fills a span with information about the font's variation axes.</summary>
<returns>The number of variation axis infos written to <paramref name="axes" />.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GlyphCount">
Expand Down Expand Up @@ -428,9 +428,9 @@
<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 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>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HasColorPng">
Expand All @@ -446,9 +446,9 @@
<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 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>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HasColorSvg">
Expand All @@ -464,9 +464,9 @@
<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 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>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HasPalettes">
Expand All @@ -482,9 +482,9 @@
<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 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>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HasVariationData">
Expand All @@ -500,9 +500,9 @@
<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 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>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Index">
Expand Down Expand Up @@ -573,9 +573,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 instances in the font face.</summary>
<value>The number of named instances defined in the font's fvar table.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PaletteCount">
Expand All @@ -591,9 +591,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 in the font face.</summary>
<value>The number of color palettes defined in the font's CPAL table.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ReferenceTable">
Expand Down Expand Up @@ -653,11 +653,11 @@
<Parameter Name="axisInfo" Type="HarfBuzzSharp.OpenTypeVarAxisInfo" RefType="out" />
</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 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>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="UnitsPerEm">
Expand Down Expand Up @@ -691,9 +691,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 in the font face.</summary>
<value>The number of variation axes defined in the font's fvar table.</value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="VariationAxisInfos">
Expand All @@ -709,9 +709,9 @@
<ReturnType>HarfBuzzSharp.OpenTypeVarAxisInfo[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets information about all variation axes in the font 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;" />
</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">A span to receive the normalized coordinate values in the range [-16384, 16384].</param>
<summary>Fills a span with the current normalized variation coordinates for this font.</summary>
<returns>The number of normalized coordinates written to <paramref name="coords" />.</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;" />
</Parameters>
<Docs>
<param name="coords">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="coords">A read-only span of design-space coordinate values, one per variation axis.</param>
<summary>Sets the variation coordinates for this font using design-space values.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetVariationCoordsNormalized">
Expand All @@ -600,9 +600,9 @@
<Parameter Name="coords" Type="System.ReadOnlySpan&lt;System.Int32&gt;" />
</Parameters>
<Docs>
<param name="coords">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="coords">A read-only span of normalized coordinate values in the range [-16384, 16384], one per variation axis.</param>
<summary>Sets the variation coordinates for this font using normalized values.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetVariationNamedInstance">
Expand All @@ -621,9 +621,9 @@
<Parameter Name="instanceIndex" Type="System.Int32" />
</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 apply.</param>
<summary>Sets the variation coordinates for this font to those of 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;" />
</Parameters>
<Docs>
<param name="variations">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="variations">A read-only span of <see cref="T:HarfBuzzSharp.Variation" /> values specifying the axis tag and design-space value for each axis to set.</param>
<summary>Sets the variation coordinates for this font using an array of tag-value pairs.</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 [-16384, 16384], one per variation axis.</value>
<remarks></remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading