Skip to content

Commit a6074be

Browse files
committed
More doc improvements
1 parent 27d9f40 commit a6074be

File tree

9 files changed

+39
-39
lines changed

9 files changed

+39
-39
lines changed

SkiaSharpAPI/SkiaSharp/SKAbstractManagedStream.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@
218218
</ReturnValue>
219219
<Parameters />
220220
<Docs>
221-
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to get the current position in the stream</summary>
221+
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to get the current position in the stream.</summary>
222222
<returns>Returns the current position in the stream.</returns>
223223
<remarks />
224224
</Docs>

SkiaSharpAPI/SkiaSharp/SKCanvas.xml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ using (var surface = SKSurface.Create(info)) {
397397
</Parameters>
398398
<Docs>
399399
<param name="path">The path to combine with the current clip.</param>
400-
<param name="operation">The clip operator to apply to the current clip</param>
400+
<param name="operation">The clip operator to apply to the current clip.</param>
401401
<param name="antialias">
402402
<see langword="true" /> to antialias the clip; otherwise, <see langword="false" />.</param>
403403
<summary>Modify the current clip with the specified path.</summary>
@@ -481,7 +481,7 @@ using (var surface = SKSurface.Create(info)) {
481481
</Parameters>
482482
<Docs>
483483
<param name="rect">The rounded rectangle to combine with the current clip.</param>
484-
<param name="operation">The clip operator to apply to the current clip</param>
484+
<param name="operation">The clip operator to apply to the current clip.</param>
485485
<param name="antialias">
486486
<see langword="true" /> to antialias the clip; otherwise, <see langword="false" />.</param>
487487
<summary>Modify the current clip with the specified rounded rectangle.</summary>
@@ -2596,8 +2596,8 @@ contours intersect each other (think <xref:SkiaSharp.SKBlendMode.Xor>).
25962596
</Parameters>
25972597
<Docs>
25982598
<param name="buffer">The pointer to a region holding UTF-8 encoded text to draw.</param>
2599-
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
2600-
<param name="points">The positions for each glyph in the <paramref name="buffer." /></param>
2599+
<param name="length">The number of bytes to read from the <paramref name="buffer" /></param>
2600+
<param name="points">The positions for each glyph in the <paramref name="buffer" /></param>
26012601
<param name="paint">The paint to use when drawing the text.</param>
26022602
<summary>Draws text from a UTF-8 buffer at specified locations on the canvas.</summary>
26032603
<remarks />
@@ -3111,7 +3111,7 @@ using (var surface = SKSurface.Create(info)) {
31113111
</Parameters>
31123112
<Docs>
31133113
<param name="buffer">The pointer to a region holding UTF-8 encoded text to draw.</param>
3114-
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
3114+
<param name="length">The number of bytes to read from the <paramref name="buffer" /></param>
31153115
<param name="p">The coordinates of the origin of the text being drawn.</param>
31163116
<param name="paint">The paint to use when drawing the text.</param>
31173117
<summary>Draws text encoded in a UTF-8 buffer on the canvas at the specified coordinates.</summary>
@@ -3211,7 +3211,7 @@ using (var surface = SKSurface.Create(info)) {
32113211
</Parameters>
32123212
<Docs>
32133213
<param name="buffer">The pointer to a region holding UTF-8 encoded text to draw.</param>
3214-
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
3214+
<param name="length">The number of bytes to read from the <paramref name="buffer" /></param>
32153215
<param name="x">The x-coordinate of the origin of the text being drawn.</param>
32163216
<param name="y">The y-coordinate of the origin of the text being drawn.</param>
32173217
<param name="paint">The paint to use when drawing the text.</param>
@@ -3452,7 +3452,7 @@ using (var surface = SKSurface.Create(info)) {
34523452
</Parameters>
34533453
<Docs>
34543454
<param name="buffer">The pointer to a region holding UTF-8 encoded text to draw.</param>
3455-
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
3455+
<param name="length">The number of bytes to read from the <paramref name="buffer" /></param>
34563456
<param name="path">The path the text should follow for its baseline.</param>
34573457
<param name="offset">The offset to the path to add to the text's starting position.</param>
34583458
<param name="paint">The paint to use when drawing the text.</param>
@@ -3595,7 +3595,7 @@ using (var surface = SKSurface.Create(info)) {
35953595
</Parameters>
35963596
<Docs>
35973597
<param name="buffer">The pointer to a region holding UTF-8 encoded text to draw.</param>
3598-
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
3598+
<param name="length">The number of bytes to read from the <paramref name="buffer" /></param>
35993599
<param name="path">The path the text should follow for its baseline.</param>
36003600
<param name="hOffset">The distance along the path to add to the text's starting position.</param>
36013601
<param name="vOffset">The distance above (-) or below (+) the path to position the text.</param>
@@ -4082,7 +4082,7 @@ safely ignored.
40824082
</ReturnValue>
40834083
<Docs>
40844084
<summary>Gets a value indicating whether the current clip is empty.</summary>
4085-
<value>true if the clip is empty; otherwise, false.</value>
4085+
<value><see langword="true" /> if the clip is empty; otherwise, <see langword="false" />.</value>
40864086
<remarks />
40874087
</Docs>
40884088
</Member>
@@ -4103,7 +4103,7 @@ safely ignored.
41034103
</ReturnValue>
41044104
<Docs>
41054105
<summary>Gets a value indicating whether the current clip is a rectangle.</summary>
4106-
<value>true if the clip is a rectangle; otherwise, false.</value>
4106+
<value><see langword="true" /> if the clip is a rectangle; otherwise, <see langword="false" />.</value>
41074107
<remarks />
41084108
</Docs>
41094109
</Member>
@@ -4827,7 +4827,7 @@ guaranteed to happen. If exact clipping is desired, use
48274827
<Parameter Name="dy" Type="System.Single" />
48284828
</Parameters>
48294829
<Docs>
4830-
<param name="dx">The distance to translate in the x-direction</param>
4830+
<param name="dx">The distance to translate in the x-direction.</param>
48314831
<param name="dy">The distance to translate in the y-direction.</param>
48324832
<summary>Pre-concatenates the current matrix with the specified translation.</summary>
48334833
<remarks />

SkiaSharpAPI/SkiaSharp/SKColorSpace.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@
576576
</ReturnValue>
577577
<Parameters />
578578
<Docs>
579-
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> with the sRGB primaries, but a linear (1.0) gamma</summary>
579+
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> with the sRGB primaries, but a linear (1.0) gamma.</summary>
580580
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
581581
<remarks />
582582
</Docs>

SkiaSharpAPI/SkiaSharp/SKColorTable.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@
240240
<Parameter Name="index" Type="System.Int32" />
241241
</Parameters>
242242
<Docs>
243-
<param name="index"></param>
243+
<param name="index">The index of the color to retrieve.</param>
244244
<summary>Gets the premultiplied color at the specified index.</summary>
245245
<value>The premultiplied color at the specified index.</value>
246246
<remarks />

SkiaSharpAPI/SkiaSharp/SKFontStyleSet.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
</Interface>
3434
</Interfaces>
3535
<Docs>
36-
<summary>Represets the set of styles for a particular font family.</summary>
36+
<summary>Represents the set of styles for a particular font family.</summary>
3737
<remarks />
3838
</Docs>
3939
<Members>

SkiaSharpAPI/SkiaSharp/SKFrontBufferedManagedStream.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@
229229
</ReturnValue>
230230
<Parameters />
231231
<Docs>
232-
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to get the current position in the stream</summary>
232+
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to get the current position in the stream.</summary>
233233
<returns>Returns the current position in the stream.</returns>
234234
<remarks />
235235
</Docs>

SkiaSharpAPI/SkiaSharp/SKImage.xml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
<param name="filter">The filter to apply to the current image.</param>
7272
<param name="subset">The active portion of this image.</param>
7373
<param name="clipBounds">Constrains the device-space extent of the image to the given rectangle.</param>
74-
<param name="outSubset">The active portion of the resulting image</param>
74+
<param name="outSubset">The active portion of the resulting image.</param>
7575
<param name="outOffset">The amount to translate the resulting image relative to the source when it is drawn.</param>
7676
<summary>Applies a given image filter to this image, and return the filtered result.</summary>
7777
<returns>Returns the resulting image after the filter is applied, or <see langword="null" /> if the image could not be created or would be transparent black (#00000000).</returns>
@@ -104,7 +104,7 @@
104104
<param name="filter">The filter to apply to the current image.</param>
105105
<param name="subset">The active portion of this image.</param>
106106
<param name="clipBounds">Constrains the device-space extent of the image to the given rectangle.</param>
107-
<param name="outSubset">The active portion of the resulting image</param>
107+
<param name="outSubset">The active portion of the resulting image.</param>
108108
<param name="outOffset">The amount to translate the resulting image relative to the source when it is drawn.</param>
109109
<summary>Applies a given image filter to this image, and return the filtered result.</summary>
110110
<returns>Returns the resulting image after the filter is applied, or <see langword="null" /> if the image could not be created or would be transparent black (#00000000).</returns>
@@ -1739,7 +1739,7 @@
17391739
<param name="texture">The description of the existing backend texture.</param>
17401740
<param name="colorType">The color type to use for the image.</param>
17411741
<summary>Creates a new image from the specified texture.</summary>
1742-
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
1742+
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported.</returns>
17431743
<remarks />
17441744
</Docs>
17451745
</Member>
@@ -1868,7 +1868,7 @@
18681868
<param name="origin">The origin of the texture.</param>
18691869
<param name="colorType">The color type to use for the image.</param>
18701870
<summary>Creates a new image from the specified texture.</summary>
1871-
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
1871+
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported.</returns>
18721872
<remarks />
18731873
</Docs>
18741874
</Member>
@@ -2005,7 +2005,7 @@
20052005
<param name="colorType">The color type to use for the image.</param>
20062006
<param name="alpha">The transparency mode to use for the image.</param>
20072007
<summary>Creates a new image from the specified texture.</summary>
2008-
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
2008+
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported.</returns>
20092009
<remarks />
20102010
</Docs>
20112011
</Member>
@@ -2044,7 +2044,7 @@
20442044
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
20452045
<param name="releaseContext">The user data to use when invoking the delegate.</param>
20462046
<summary>Creates a new image from the specified texture descriptor.</summary>
2047-
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported</returns>
2047+
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
20482048
<remarks />
20492049
</Docs>
20502050
</Member>
@@ -2083,7 +2083,7 @@
20832083
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
20842084
<param name="releaseContext">The user data to use when invoking the delegate.</param>
20852085
<summary>Creates a new image from the specified OpenGL texture descriptor.</summary>
2086-
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported</returns>
2086+
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
20872087
<remarks />
20882088
</Docs>
20892089
</Member>
@@ -2150,7 +2150,7 @@
21502150
<param name="alpha">The transparency mode to use for the image.</param>
21512151
<param name="colorspace">The colorspace to use for the image.</param>
21522152
<summary>Creates a new image from the specified texture.</summary>
2153-
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
2153+
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported.</returns>
21542154
<remarks />
21552155
</Docs>
21562156
</Member>
@@ -2221,7 +2221,7 @@
22212221
<param name="colorspace">The colorspace to use for the image.</param>
22222222
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
22232223
<summary>Creates a new image from the specified texture.</summary>
2224-
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
2224+
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported.</returns>
22252225
<remarks />
22262226
</Docs>
22272227
</Member>
@@ -2296,7 +2296,7 @@
22962296
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
22972297
<param name="releaseContext">The user data to use when invoking the delegate.</param>
22982298
<summary>Creates a new image from the specified texture.</summary>
2299-
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
2299+
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported.</returns>
23002300
<remarks />
23012301
</Docs>
23022302
</Member>

SkiaSharpAPI/SkiaSharp/SKManagedStream.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ public static void BitmapShader (SKCanvas canvas, int width, int height)
281281
</ReturnValue>
282282
<Parameters />
283283
<Docs>
284-
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to get the current position in the stream</summary>
284+
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to get the current position in the stream.</summary>
285285
<returns>Returns the current position in the stream.</returns>
286286
<remarks />
287287
</Docs>

0 commit comments

Comments
 (0)