Skip to content

Fill API documentation placeholders #119

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

Closed
github-actions wants to merge 1 commit into from
Closed

Fill API documentation placeholders #119

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">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>Gets the design coordinates for the specified named variation instance.</summary>
<returns>An array of design coordinates 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 receive the design coordinates.</param>
<summary>Fills a span with the design coordinates for the specified named variation instance.</summary>
<returns>The number of design 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" 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>Gets the number of design coordinates for the specified named variation instance.</summary>
<returns>The number of design 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" 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>Gets the PostScript name identifier for the specified named variation instance.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> for the PostScript name of the named instance.</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>Gets the subfamily name identifier for the specified named variation instance.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> for the subfamily name of the named instance.</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 color entry.</param>
<summary>Gets the name identifier for the specified color entry within any palette.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> for the color entry name.</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>Gets the colors of the specified palette.</summary>
<returns>An array of packed color values (BGRA byte order: blue in the high byte, alpha in the low byte) for the specified palette.</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 receive the packed color values (BGRA byte order: blue in the high byte, alpha in the low byte).</param>
<summary>Fills a span with the colors of the specified palette.</summary>
<returns>The number of color values 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" 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>Gets the flags for the specified palette.</summary>
<returns>One of the <see cref="T:HarfBuzzSharp.OpenTypeColorPaletteFlags" /> values that describes 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>Gets the name identifier for the specified palette.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> for the palette name.</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 receive the variation axis information.</param>
<summary>Fills a span with information about the variation axes of the font face.</summary>
<returns>The number of axes 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 color layers (COLR table).</summary>
<value><see langword="true" /> if the font face has 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 PNG color glyphs (CBDT/CBLC tables).</summary>
<value><see langword="true" /> if the font face has embedded PNG color glyphs; 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 SVG color glyphs (SVG table).</summary>
<value><see langword="true" /> if the font face has an SVG color glyph 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 color palettes (CPAL table).</summary>
<value><see langword="true" /> if the font face has 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 (fvar/gvar tables).</summary>
<value><see langword="true" /> if the font face has OpenType variation data; 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 variation instances defined in the font face.</summary>
<value>The number of named instances 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 palettes 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" 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 four-byte tag identifying 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 a variation axis by its four-byte 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 defined in the font face.</summary>
<value>The number of variation axes 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 an array containing information about all variation axes in the font face.</summary>
<value>An array of <see cref="T:HarfBuzzSharp.OpenTypeVarAxisInfo" /> values, one per 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 receive the normalized variation coordinates.</param>
<summary>Fills a span with the current variation coordinates in normalized form.</summary>
<returns>The number of 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;" 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-space variation coordinates, one per variation axis in fvar order.</param>
<summary>Sets the variation coordinates 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;" 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 variation coordinates in the range [-1.0, 1.0], one per axis in fvar order.</param>
<summary>Sets the variation coordinates using normalized values.</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 apply.</param>
<summary>Sets the font variation to a named instance defined in the font face.</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 variation axis and value pairs to apply.</param>
<summary>Sets the font variation using a span of axis–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 variation coordinates in normalized form.</summary>
<value>An array of normalized variation coordinates in the range [-1.0, 1.0], one per axis.</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