Skip to content

Commit 22667ee

Browse files
authored
[net10.0] A few minor xml docs updates. (#23969)
* Don't use the 'remarks' element for enum fields, they're ignored in the publishing process. * Fix the 'inheritdocs' element on CMVideoDimensions, the docs pipeline says it can't be resolved, so just provide explicit docs. * Update all the other xml docs for CMVideoDimensions as well. * Fix horribly incorrect docs for CGRect.ToString.
1 parent 2321e01 commit 22667ee

File tree

4 files changed

+13
-25
lines changed

4 files changed

+13
-25
lines changed

src/AudioToolbox/Enums.cs

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,22 +65,18 @@ public enum AUVoiceIOOtherAudioDuckingLevel : uint {
6565
/// <summary>This enum specifies properties for <see cref="AudioUnitSubType.AUAudioMix" /> audio units.</summary>
6666
[Mac (26, 0), iOS (26, 0), MacCatalyst (26, 0), NoTV]
6767
public enum AUAudioMixProperty {
68-
/// <summary>Remix the data from the file asset.</summary>
69-
/// <remarks>This is a read-write <see cref="NSData" /> property.</remarks>
68+
/// <summary>Remix the data from the file asset, using an <see cref="NSData" />.</summary>
7069
SpatialAudioMixMetadata = 5000,
71-
/// <summary>If spatialization is enabled or not.</summary>
72-
/// <remarks>This is a read-write <see langword="uint" /> property, with two possible values: 0 or 1.</remarks>
70+
/// <summary>If spatialization is enabled or not. Specified with a <see langword="uint" />, which is either 0 (false) or 1 (true).</summary>
7371
EnableSpatialization = 5001,
7472
}
7573

7674
/// <summary>This enum specifies parameters for <see cref="AudioUnitSubType.AUAudioMix" /> audio units.</summary>
7775
public enum AUAudioMixParameter {
78-
/// <summary>Get or set the style of the audio mixing.</summary>
79-
/// <remarks>This property is an enum of type <see cref="AUAudioMixRenderingStyle" />.</remarks>
76+
/// <summary>Get or set the style of the audio mixing, using a value of the <see cref="AUAudioMixRenderingStyle" /> enum.</summary>
8077
[Mac (26, 0), iOS (26, 0), MacCatalyst (26, 0), NoTV]
8178
Style = 0,
82-
/// <summary>The remix amount.</summary>
83-
/// <remarks>This property is a <see langword="float" />, with valid values ranging from 0.0f to 1.0f. The default value is 0.5f.</remarks>
79+
/// <summary>The remix amount, which is a <see langword="float" />, with valid values ranging from 0.0f to 1.0f. The default value is 0.5f.</summary>
8480
[Mac (26, 0), iOS (26, 0), MacCatalyst (26, 0), NoTV]
8581
RemixAmount = 1,
8682
}

src/AudioUnit/AUEnums.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1482,14 +1482,11 @@ public enum AudioUnitSubType : uint {
14821482
/// <summary>To be added.</summary>
14831483
AudioFilePlayer = 0x6166706C, // 'afpl'
14841484
/// <summary>A light reverb.</summary>
1485-
/// <remarks>The FourCC value for 'rvb2', for the native constant kAudioUnitSubType_Reverb2.</remarks>
14861485
Reverb2 = 0x72766232, // 'rvb2'
14871486
/// <summary>An audio unit that can be used to isolate a sound type.</summary>
1488-
/// <remarks>The FourCC value for 'vois', for the native constant kAudioUnitSubType_AUSoundIsolation.</remarks>
14891487
[iOS (16, 0), Mac (13, 0), MacCatalyst (16, 0), NoTV]
14901488
AUSoundIsolation = 0x766f6973, // 'vois'
14911489
/// <summary>An audio unit that supports AudioMix separate-and-remix.</summary>
1492-
/// <remarks>The FourCC value for 'amix', for the native constant kAudioUnitSubType_AUAudioMix.</remarks>
14931490
[iOS (26, 0), Mac (26, 0), MacCatalyst (26, 0), NoTV]
14941491
AUAudioMix = 0x616d6978, // 'amix'
14951492
#if MONOMAC

src/CoreGraphics/CGRect.cs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -524,10 +524,8 @@ public override int GetHashCode ()
524524
}
525525

526526
#if !COREBUILD
527-
/// <summary>Gets the y-coordinate of the top edge of this <see cref="CoreGraphics.CGRect" /> structure.</summary>
528-
/// <returns />
529-
/// <remarks>
530-
/// </remarks>
527+
/// <summary>Converts this instance to a human readable string.</summary>
528+
/// <returns>A string that represents this instance.</returns>
531529
public override string? ToString ()
532530
{
533531
return CFString.FromHandle (NSStringFromCGRect (this));

src/CoreMedia/CoreMedia.cs

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -259,30 +259,27 @@ public CMTimeScale (int value)
259259

260260
// CMVideoDimensions => int32_t width + int32_t height
261261
/// <summary>Struct that contains the width and height of video media.</summary>
262-
/// <remarks>To be added.</remarks>
263262
[SupportedOSPlatform ("ios")]
264263
[SupportedOSPlatform ("maccatalyst")]
265264
[SupportedOSPlatform ("macos")]
266265
[SupportedOSPlatform ("tvos")]
267266
public struct CMVideoDimensions {
268-
/// <summary>To be added.</summary>
269-
/// <remarks>To be added.</remarks>
267+
/// <summary>The width of the video media.</summary>
270268
public int Width;
271-
/// <summary>To be added.</summary>
272-
/// <remarks>To be added.</remarks>
269+
/// <summary>The height of the video media.</summary>
273270
public int Height;
274271

275-
/// <param name="width">To be added.</param>
276-
/// <param name="height">To be added.</param>
277-
/// <summary>To be added.</summary>
278-
/// <remarks>To be added.</remarks>
272+
/// <summary>Create a new <see cref="CMVideoDimensions" /> instance with the specified width and height.</summary>
273+
/// <param name="width">The width of the video media.</param>
274+
/// <param name="height">The height of the video media.</param>
279275
public CMVideoDimensions (int width, int height)
280276
{
281277
Width = width;
282278
Height = height;
283279
}
284280

285-
/// <inheritdoc />
281+
/// <summary>Converts this instance to a human readable string.</summary>
282+
/// <returns>A string that represents this instance.</returns>
286283
public override string ToString ()
287284
{
288285
return $"[{Width}, {Height}]";

0 commit comments

Comments
 (0)