Skip to content

Fill all documentation placeholders for SkiaSharp 3.x APIs #145

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 all documentation placeholders for SkiaSharp 3.x APIs #145

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
10 changes: 10 additions & 0 deletions SkiaSharpAPI/FrameworksIndex/skiasharp-views.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,16 @@
<Member Id="P:SkiaSharp.Views.Blazor.SKPaintSurfaceEventArgs.Surface" />
</Type>
</Namespace>
<Namespace Name="SkiaSharp.Views.Blazor.Internal">
<Type Name="SkiaSharp.Views.Blazor.Internal.ActionHelper" Id="T:SkiaSharp.Views.Blazor.Internal.ActionHelper">
<Member Id="M:SkiaSharp.Views.Blazor.Internal.ActionHelper.#ctor(System.Action)" />
<Member Id="M:SkiaSharp.Views.Blazor.Internal.ActionHelper.Invoke" />
</Type>
<Type Name="SkiaSharp.Views.Blazor.Internal.FloatFloatActionHelper" Id="T:SkiaSharp.Views.Blazor.Internal.FloatFloatActionHelper">
<Member Id="M:SkiaSharp.Views.Blazor.Internal.FloatFloatActionHelper.#ctor(System.Action{System.Single,System.Single})" />
<Member Id="M:SkiaSharp.Views.Blazor.Internal.FloatFloatActionHelper.Invoke(System.Single,System.Single)" />
</Type>
</Namespace>
<Namespace Name="SkiaSharp.Views.Desktop">
<Type Name="SkiaSharp.Views.Desktop.Extensions" Id="T:SkiaSharp.Views.Desktop.Extensions">
<Member Id="M:SkiaSharp.Views.Desktop.Extensions.ToBitmap(SkiaSharp.SKBitmap)" />
Expand Down
143 changes: 0 additions & 143 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 coordinates for the specified named instance.</summary>
<returns>An array containing the design-space coordinates for each variation axis of 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;" />
</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 the design-space coordinates for each variation axis.</param>
<summary>Fills the provided span with the design coordinates for the specified named instance.</summary>
<returns>The number of 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" />
</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 total number of design-space coordinates (one per variation axis) 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 identifier for the PostScript name of the specified named 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" />
</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 identifier for the subfamily name of the specified named 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" />
</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>Returns the OpenType name identifier for the specified palette color entry.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> that names the color entry.</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 colors in the specified color palette.</summary>
<returns>An array of <see cref="T:HarfBuzzSharp.HBColor" /> values representing each color in the palette.</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">The span to fill with the palette colors.</param>
<summary>Fills the provided span with the colors from the specified color palette.</summary>
<returns>The number of color values 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" />
</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 that describe the intended usage of the specified color palette.</summary>
<returns>One of the <see cref="T:HarfBuzzSharp.OpenTypeColorPaletteFlags" /> values.</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 identifier for the specified color palette.</summary>
<returns>The <see cref="T:HarfBuzzSharp.OpenTypeNameId" /> that names 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;" />
</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 the variation axis information.</param>
<summary>Fills the provided span with information about the variation axes defined in the font.</summary>
<returns>The number of <see cref="T:HarfBuzzSharp.OpenTypeVarAxisInfo" /> values 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 color glyph layers (COLR table).</summary>
<value><see langword="true" /> if the font face has a COLR table with color layers; 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 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 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 table).</summary>
<value><see langword="true" /> if the font face has 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.</summary>
<value>The number of named instances in the font's variation 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 defined in the font.</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" />
</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.</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.</summary>
<value>The number of variation axes in the font's variation 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 defined in the font.</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;" />
</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 the normalized variation coordinates.</param>
<summary>Fills the provided span with the normalized variation coordinates currently applied to the font.</summary>
<returns>The number of 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;" />
</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 coordinates, one value per variation axis in the order defined by the face.</param>
<summary>Sets the variation axes of the font using design-space coordinates.</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">The normalized coordinates in the range [-1, 1], one value per variation axis in the order defined by the face.</param>
<summary>Sets the variation axes of the font using normalized coordinates.</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 defined in the font face.</param>
<summary>Sets the variation axes of the font to the design coordinates 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">The variation values to apply, each identifying an axis by tag and specifying the desired value.</param>
<summary>Sets one or more variation axes of the font using axis tag and 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 an array of the normalized variation coordinates currently applied to the font.</summary>
<value>An array of normalized variation coordinates, one per variation axis.</value>
<remarks></remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading
Loading