Skip to content

Revert "Fill API documentation placeholders" #95

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
May 15, 2026
Merged

Revert "Fill API documentation placeholders" #95

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
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" Index="0" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="instanceIndex">The zero-based index of the named instance.</param>
<summary>Gets the design-space coordinates for a named instance.</summary>
<returns>An array of design-space coordinate values for the named instance.</returns>
<remarks></remarks>
<param name="instanceIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</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">The zero-based index of the named instance.</param>
<param name="coords">The span to fill with the design-space coordinate values.</param>
<summary>Fills a span with the design-space coordinates for a named instance.</summary>
<returns>The number of coordinates written to the span.</returns>
<remarks></remarks>
<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>
</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">The zero-based index of the named instance.</param>
<summary>Gets the number of design-space coordinates for a named instance.</summary>
<returns>The number of design-space coordinates for the named instance.</returns>
<remarks></remarks>
<param name="instanceIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</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">The zero-based index of the named instance.</param>
<summary>Gets the name ID of the PostScript name for a named instance.</summary>
<returns>The OpenType name ID of the PostScript name for the named instance.</returns>
<remarks></remarks>
<param name="instanceIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</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">The zero-based index of the named instance.</param>
<summary>Gets the name ID of the subfamily name for a named instance.</summary>
<returns>The OpenType name ID of the subfamily name for the named instance.</returns>
<remarks></remarks>
<param name="instanceIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</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">The zero-based index of the color entry.</param>
<summary>Gets the name ID of the color entry at the specified index in a color palette.</summary>
<returns>The OpenType name ID of the color entry name.</returns>
<remarks></remarks>
<param name="colorIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</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">The zero-based index of the color palette.</param>
<summary>Gets the colors in a color palette.</summary>
<returns>An array of packed ARGB color values in the palette.</returns>
<remarks></remarks>
<param name="paletteIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</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">The zero-based index of the color palette.</param>
<param name="colors">The span to fill with packed ARGB color values.</param>
<summary>Fills a span with the colors in a color palette.</summary>
<returns>The number of colors written to the span.</returns>
<remarks></remarks>
<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>
</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">The zero-based index of the color palette.</param>
<summary>Gets the flags for a color palette.</summary>
<returns>The flags describing the palette, such as whether it is a light or dark palette.</returns>
<remarks></remarks>
<param name="paletteIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</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">The zero-based index of the color palette.</param>
<summary>Gets the name ID for a color palette.</summary>
<returns>The OpenType name ID of the palette name.</returns>
<remarks></remarks>
<param name="paletteIndex">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</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">The span to fill with variation axis information.</param>
<summary>Fills a span with information about the font's variation axes.</summary>
<returns>The number of variation axes written to the span.</returns>
<remarks></remarks>
<param name="axes">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GlyphCount">
Expand Down Expand Up @@ -428,9 +428,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether this face contains COLRv0 color glyph layers.</summary>
<value><see langword="true" /> if the face has a COLR table with color layers; otherwise, <see langword="false" />.</value>
<remarks></remarks>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasColorPng">
Expand All @@ -446,9 +446,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether this face contains PNG color glyphs.</summary>
<value><see langword="true" /> if the face has a CBDT/CBLC or sbix table with PNG images; otherwise, <see langword="false" />.</value>
<remarks></remarks>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasColorSvg">
Expand All @@ -464,9 +464,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether this face contains SVG color glyphs.</summary>
<value><see langword="true" /> if the face has an SVG table; otherwise, <see langword="false" />.</value>
<remarks></remarks>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasPalettes">
Expand All @@ -482,9 +482,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether this face contains color palettes.</summary>
<value><see langword="true" /> if the face has a CPAL table with color palettes; otherwise, <see langword="false" />.</value>
<remarks></remarks>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasVariationData">
Expand All @@ -500,9 +500,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether this face contains OpenType variation data.</summary>
<value><see langword="true" /> if the face has variation data such as an fvar table; otherwise, <see langword="false" />.</value>
<remarks></remarks>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Index">
Expand Down Expand Up @@ -573,9 +573,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the number of named instances defined in the font.</summary>
<value>The number of named instances in the font's fvar table.</value>
<remarks></remarks>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PaletteCount">
Expand All @@ -591,9 +591,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the number of color palettes defined in the font.</summary>
<value>The number of color palettes in the font's CPAL table.</value>
<remarks></remarks>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReferenceTable">
Expand Down Expand Up @@ -653,11 +653,11 @@
<Parameter Name="axisInfo" Type="HarfBuzzSharp.OpenTypeVarAxisInfo" RefType="out" Index="1" FrameworkAlternate="harfbuzzsharp-8.3" />
</Parameters>
<Docs>
<param name="tag">The four-byte tag identifying the variation axis.</param>
<param name="axisInfo">When this method returns, contains information about the variation axis if found.</param>
<summary>Tries to find a variation axis by its tag.</summary>
<returns><see langword="true" /> if the axis was found; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
<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>
</Docs>
</Member>
<Member MemberName="UnitsPerEm">
Expand Down Expand Up @@ -691,9 +691,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the number of variation axes defined in the font.</summary>
<value>The number of variation axes in the font's fvar table.</value>
<remarks></remarks>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="VariationAxisInfos">
Expand All @@ -709,9 +709,9 @@
<ReturnType>HarfBuzzSharp.OpenTypeVarAxisInfo[]</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets an array of information about each variation axis defined in the font.</summary>
<value>An array of <see cref="T:HarfBuzzSharp.OpenTypeVarAxisInfo" /> describing each variation axis.</value>
<remarks></remarks>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</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">The span to fill with normalized variation coordinate values.</param>
<summary>Fills a span with the font's current variation coordinates in normalized form.</summary>
<returns>The number of coordinates written to the span.</returns>
<remarks></remarks>
<param name="coords">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</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">The design-space coordinate values to set, one per variation axis.</param>
<summary>Sets the font's variation axes using design-space coordinate values.</summary>
<remarks></remarks>
<param name="coords">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</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">The normalized coordinate values to set, one per variation axis.</param>
<summary>Sets the font's variation axes using normalized coordinate values.</summary>
<remarks></remarks>
<param name="coords">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</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">The zero-based index of the named instance to apply.</param>
<summary>Sets the font's variation axes to match a named instance.</summary>
<remarks></remarks>
<param name="instanceIndex">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</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">The variation tag-value pairs to apply.</param>
<summary>Sets the font's variation axes using a collection of tag-value pairs.</summary>
<remarks></remarks>
<param name="variations">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Shape">
Expand Down Expand Up @@ -1250,9 +1250,9 @@
<ReturnType>System.Int32[]</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets an array of the font's current variation coordinates in normalized form.</summary>
<value>An array of normalized variation coordinate values, one per variation axis.</value>
<remarks></remarks>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</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>Executes the Blazor component imports.</summary>
<remarks></remarks>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading