Skip to content

Commit 3d00dc0

Browse files
rolfbjarneCopilot
andauthored
[docs] Improve XML docs for ten types (#26407)
Improve XML documentation for: - `VSAccountProviderAuthenticationSchemeExtensions` - `EKCalendarChooserSelectionStyle` - `EKCalendarChooserDisplayStyle` - `EKEventViewAction` - `EKEventEditViewAction` - `CMMagneticFieldCalibrationAccuracy` - `SSReadingListError` - `CTErrorDomain` - `CTCellularDataRestrictedState` - `CTCellularPlanProvisioningAddPlanResult` Each type is documented in a separate commit. The Cecil documentation baseline is updated for the newly documented `CTCellularPlanProvisioningAddPlanResult` API. 🤖 Pull request created by Copilot --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 0d9d023 commit 3d00dc0

6 files changed

Lines changed: 27 additions & 30 deletions

File tree

src/CoreMotion/Defs.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,6 @@ public override string ToString ()
168168

169169
// untyped enum -> CMDeviceMotion.h
170170
/// <summary>An enumeration whose values specify the quality of the magnetometer calibration.</summary>
171-
/// <remarks>To be added.</remarks>
172171
public enum CMMagneticFieldCalibrationAccuracy {
173172
/// <summary>Magnetic calibration has not occurred.</summary>
174173
Uncalibrated = -1,

src/CoreTelephony/CTEnums.cs

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,37 @@ namespace CoreTelephony {
77
// in header file this is used inside a CTError structure where the domain is a SInt32
88
/// <summary>An enumeration whose values specify an error domain.</summary>
99
public enum CTErrorDomain {
10-
/// <summary>To be added.</summary>
10+
/// <summary>No error occurred.</summary>
1111
NoError = 0,
12-
/// <summary>To be added.</summary>
12+
/// <summary>The error is in the POSIX error domain.</summary>
1313
Posix = 1,
14-
/// <summary>To be added.</summary>
14+
/// <summary>The error is in the Mach error domain.</summary>
1515
Mach = 2,
1616
}
1717

1818
/// <summary>Enumerates data restrictions for <see cref="CoreTelephony.CTCellularData.RestrictedState" />.</summary>
1919
[MacCatalyst (13, 1)]
2020
[Native]
2121
public enum CTCellularDataRestrictedState : ulong {
22-
/// <summary>To be added.</summary>
22+
/// <summary>The cellular data restriction state is unknown.</summary>
2323
Unknown,
24-
/// <summary>To be added.</summary>
24+
/// <summary>Cellular data access is restricted.</summary>
2525
Restricted,
26-
/// <summary>To be added.</summary>
26+
/// <summary>Cellular data access is not restricted.</summary>
2727
NotRestricted,
2828
}
2929

30+
/// <summary>Enumerates the results of adding a cellular plan.</summary>
3031
[MacCatalyst (13, 1)]
3132
[Native]
3233
public enum CTCellularPlanProvisioningAddPlanResult : long {
33-
/// <summary>To be added.</summary>
34+
/// <summary>The result is unknown.</summary>
3435
Unknown,
35-
/// <summary>To be added.</summary>
36+
/// <summary>The cellular plan could not be added.</summary>
3637
Fail,
37-
/// <summary>To be added.</summary>
38+
/// <summary>The cellular plan was added successfully.</summary>
3839
Success,
40+
/// <summary>The operation was canceled.</summary>
3941
[iOS (17, 0)]
4042
Cancel,
4143
}

src/EventKitUI/Defs.cs

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,28 @@ namespace EventKitUI {
1414
// untyped enum -> EKCalendarChooser.h
1515
// iOS 9 promoted this to an NSInteger - which breaks compatibility
1616
/// <summary>An enumeration whose values specify whether a single or multiple calendars can be chosen by an <see cref="EventKitUI.EKCalendarChooser" /> object.</summary>
17-
/// <remarks>To be added.</remarks>
1817
[Native]
1918
public enum EKCalendarChooserSelectionStyle : long {
20-
/// <summary>To be added.</summary>
19+
/// <summary>Allows the user to select one calendar.</summary>
2120
Single,
22-
/// <summary>To be added.</summary>
21+
/// <summary>Allows the user to select multiple calendars.</summary>
2322
Multiple,
2423
}
2524

2625
// untyped enum -> EKCalendarChooser.h
2726
// iOS 9 promoted this to an NSInteger - which breaks compatibility
2827
/// <summary>An enumeration whose values specify which calendars are displayed by a <see cref="EventKitUI.EKCalendarChooser" />.</summary>
29-
/// <remarks>To be added.</remarks>
3028
[Native]
3129
public enum EKCalendarChooserDisplayStyle : long {
32-
/// <summary>To be added.</summary>
30+
/// <summary>Displays all calendars.</summary>
3331
AllCalendars,
34-
/// <summary>To be added.</summary>
32+
/// <summary>Displays only calendars that the user can modify.</summary>
3533
WritableCalendarsOnly,
3634
}
3735

3836
// untyped enum -> EKEventViewController.h
3937
// iOS 9 promoted this to an NSInteger - which breaks compatibility
4038
/// <summary>Enumerates actions that a user can take to dismiss an event view controller.</summary>
41-
/// <remarks>To be added.</remarks>
4239
[Native]
4340
public enum EKEventViewAction : long {
4441
/// <summary>The user tapped "Done".</summary>
@@ -52,7 +49,6 @@ public enum EKEventViewAction : long {
5249
// untyped enum -> EKEventEditViewController.h
5350
// iOS 9 promoted this to an NSInteger - which breaks compatibility
5451
/// <summary>Enumerates possible actions that a user can take when editing a view.</summary>
55-
/// <remarks>To be added.</remarks>
5652
[Native]
5753
public enum EKEventEditViewAction : long {
5854
/// <summary>The user canceled the change to the event.</summary>

src/SafariServices/SSEnums.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111
namespace SafariServices {
1212

1313
// NSInteger -> SSReadingList.h
14-
/// <summary>An enumeration that specify possible errors associated with adding a URL to the Safari Reading List.</summary>
14+
/// <summary>Enumerates errors that can occur when adding a URL to the Safari Reading List.</summary>
1515
[NoMac]
1616
[MacCatalyst (14, 0)]
1717
[Native ("SSReadingListErrorCode")]
1818
[ErrorDomain ("SSReadingListErrorDomain")]
1919
public enum SSReadingListError : long {
20-
/// <summary>To be added.</summary>
20+
/// <summary>The URL scheme is not supported by the Safari Reading List.</summary>
2121
UrlSchemeNotAllowed = 1,
2222
}
2323

src/VideoSubscriberAccount/VSAccountProviderAuthenticationScheme.cs

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@
55

66
namespace VideoSubscriberAccount {
77

8+
/// <summary>Provides conversions between authentication scheme values and their native constants.</summary>
89
public static partial class VSAccountProviderAuthenticationSchemeExtensions {
910

1011
// these are less common pattern so it's not automatically generated
1112

12-
/// <param name="self">The instance on which this method operates.</param>
13-
/// <summary>To be added.</summary>
14-
/// <returns>To be added.</returns>
15-
/// <remarks>To be added.</remarks>
13+
/// <summary>Gets the native constants for the specified authentication schemes.</summary>
14+
/// <param name="self">The authentication schemes to convert.</param>
15+
/// <returns>The native constant for each authentication scheme. An element is <see langword="null" /> if the corresponding authentication scheme has no associated native constant on the current platform.</returns>
16+
/// <exception cref="ArgumentNullException"><paramref name="self" /> is <see langword="null" />.</exception>
1617
public static NSString? [] GetConstants (this VSAccountProviderAuthenticationScheme [] self)
1718
{
1819
if (self is null)
@@ -24,10 +25,11 @@ public static partial class VSAccountProviderAuthenticationSchemeExtensions {
2425
return array;
2526
}
2627

27-
/// <param name="constants">To be added.</param>
28-
/// <summary>To be added.</summary>
29-
/// <returns>To be added.</returns>
30-
/// <remarks>To be added.</remarks>
28+
/// <summary>Gets the authentication schemes for the specified native constants.</summary>
29+
/// <param name="constants">The native constants to convert.</param>
30+
/// <returns>The authentication scheme for each native constant.</returns>
31+
/// <exception cref="ArgumentNullException"><paramref name="constants" /> is <see langword="null" />.</exception>
32+
/// <exception cref="NotSupportedException">An element in <paramref name="constants" /> has no associated authentication scheme on the current platform.</exception>
3133
public static VSAccountProviderAuthenticationScheme [] GetValues (NSString [] constants)
3234
{
3335
if (constants is null)

tests/cecil-tests/Documentation.KnownFailures.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2758,7 +2758,6 @@ F:CoreSpotlight.CSUserInteraction.Focus
27582758
F:CoreSpotlight.CSUserInteraction.Select
27592759
F:CoreTelephony.CTCellularPlanCapability.AndVoice
27602760
F:CoreTelephony.CTCellularPlanCapability.Only
2761-
F:CoreTelephony.CTCellularPlanProvisioningAddPlanResult.Cancel
27622761
F:CoreText.CTFontManagerError.AssetNotFound
27632762
F:CoreText.CTFontManagerError.CancelledByUser
27642763
F:CoreText.CTFontManagerError.DuplicatedName
@@ -23903,7 +23902,6 @@ T:CoreTelephony.CTCellularPlanCapability
2390323902
T:CoreTelephony.CTCellularPlanProperties
2390423903
T:CoreTelephony.CTCellularPlanProvisioning
2390523904
T:CoreTelephony.CTCellularPlanProvisioningAddPlanCompletionHandler
23906-
T:CoreTelephony.CTCellularPlanProvisioningAddPlanResult
2390723905
T:CoreTelephony.CTCellularPlanProvisioningRequest
2390823906
T:CoreTelephony.CTCellularPlanProvisioningUpdateCellularPlanCompletionHandler
2390923907
T:CoreTelephony.CTCellularPlanStatus

0 commit comments

Comments
 (0)