Skip to content

Fill API documentation placeholders #118

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 #118

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>Returns all design-space coordinates for the specified named instance.</summary>
<returns>An array of design-space coordinates for the named instance, one value per variation axis, or an empty array if the instance has no coordinates.</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">A span to receive the design-space coordinates. The span should be large enough to hold all coordinates; see <see cref="M:HarfBuzzSharp.Face.GetNamedInstanceDesignCoordsCount(System.Int32)" />.</param>
<summary>Fills a span with the design-space coordinates for the specified named instance.</summary>
<returns>The number of design-space coordinates written into <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-space coordinates for the specified named instance.</summary>
<returns>The total 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" 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 OpenType name ID for the PostScript name of the specified named instance.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> that identifies the PostScript name for the named instance in the font name table.</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 OpenType name ID for the subfamily name of the specified named instance.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> that identifies the subfamily name for the named instance in the font name table.</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 within a palette.</param>
<summary>Gets the OpenType name ID for the name of the specified color entry within a palette.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> that identifies the name of the palette color entry in the font name table.</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 color palette.</param>
<summary>Returns all colors in the specified color palette.</summary>
<returns>An array of packed <c>hb_color_t</c> values (BGRA byte order: <c>0xBBGGRRAA</c>) for each color entry in the palette, or an empty array if the palette has no colors.</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 color palette.</param>
<param name="colors">A span to receive the palette colors as packed <c>hb_color_t</c> values (BGRA byte order: <c>0xBBGGRRAA</c>). The span should be large enough to hold all palette entries; see <see cref="P:HarfBuzzSharp.Face.PaletteCount" />.</param>
<summary>Fills a span with the colors of the specified color palette.</summary>
<returns>The number of color entries written into <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 color palette.</param>
<summary>Gets the flags for the specified color palette.</summary>
<returns>A bitwise combination of <see cref="T:HarfBuzzSharp.OpenTypeColorPaletteFlags" /> values describing the intended use of 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 color palette.</param>
<summary>Gets the OpenType name ID for the display name of the specified color palette.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> that identifies the display name of the palette in the font name table.</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">A span to receive the variation axis information. The span should be large enough to hold all axes; see <see cref="P:HarfBuzzSharp.Face.VariationAxisCount" />.</param>
<summary>Fills a span with information about all variation axes in the font face.</summary>
<returns>The number of axis info entries written into <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 table with layered color glyphs.</summary>
<value><see langword="true" /> if the font 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 CBDT/CBLC table with PNG color bitmap glyphs.</summary>
<value><see langword="true" /> if the font contains PNG color bitmap glyph data; 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 table with scalable color glyphs.</summary>
<value><see langword="true" /> if the font contains 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 a CPAL table with color palettes.</summary>
<value><see langword="true" /> if the font 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 font contains variation axis 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 instances defined in the font face.</summary>
<value>The number of named instances in the font's variation data.</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 defined in the font face.</summary>
<value>The number of color 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 locate.</param>
<param name="axisInfo">When this method returns, contains the axis information if the axis was found. This parameter is treated as uninitialized.</param>
<summary>Attempts 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>
</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 OpenType variation data.</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 defined in the font face.</summary>
<value>An array of <see cref="T:HarfBuzzSharp.OpenTypeVarAxisInfo" /> structures describing each variation axis, or an empty array if the font has no variation data.</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">A span to receive the normalized variation coordinates. Each value is in the normalized range for its corresponding axis.</param>
<summary>Fills a span with the current normalized variation coordinates of the font.</summary>
<returns>The number of normalized coordinates written into <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">A read-only span of design-space coordinates, one per variation axis, in the order defined by the font's variation axis list.</param>
<summary>Sets the variation design-space coordinates for the 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">A read-only span of normalized variation coordinates, one per variation axis. Normalized values are in the HarfBuzz normalized fixed-point range.</param>
<summary>Sets the variation coordinates for the font 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, as reported by <see cref="P:HarfBuzzSharp.Face.NamedInstanceCount" />.</param>
<summary>Applies a named variation instance to the font by its index.</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">A read-only span of <see cref="T:HarfBuzzSharp.Variation" /> values specifying axis tags and their desired values.</param>
<summary>Sets the variation axis values for the 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 of the font.</summary>
<value>An array of normalized variation coordinates, one per variation axis, or an empty array if no variation coordinates are set.</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>This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code.</remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading