Skip to content

Commit 5a3e485

Browse files
authored
[docs] Improve XML docs for ten types (#26415)
Improve XML documentation for: - `PdfActionNamedName` - `PdfWidgetControlType` - `PdfLineStyle` - `PdfMarkupType` - `PdfTextAnnotationIconType` - `PdfBorderStyle` - `PdfDisplayBox` - `PdfDisplayMode` - `PdfAreaOfInterest` - `MKMapType` Each type is documented in a separate commit. The Cecil documentation baseline is updated for the newly documented `PdfMarkupType.Redact` and `PdfAreaOfInterest.AnyArea` APIs. 🤖 Pull request created by Copilot
1 parent c0f5924 commit 5a3e485

3 files changed

Lines changed: 8 additions & 18 deletions

File tree

src/MapKit/MKEnums.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ public enum MKDirectionsTransportType : ulong {
3737

3838
// NSUInteger -> MKTypes.h
3939
/// <summary>The type of map.</summary>
40-
/// <remarks>To be added.</remarks>
4140
[MacCatalyst (13, 1)]
4241
[Native]
4342
public enum MKMapType : ulong {
@@ -51,7 +50,7 @@ public enum MKMapType : ulong {
5150
SatelliteFlyover,
5251
/// <summary>A flyover that combines satellite and cartographic imagery.</summary>
5352
HybridFlyover,
54-
/// <summary>A muted map that emphasized developer data.</summary>
53+
/// <summary>A muted map that emphasizes developer data.</summary>
5554
[MacCatalyst (13, 1)]
5655
MutedStandard,
5756
}

src/PdfKit/Enums.cs

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@
3333

3434
namespace PdfKit {
3535

36-
/// <summary>Enumerates named PDF action names.</summary>
37-
/// <remarks>To be added.</remarks>
36+
/// <summary>Enumerates named actions that can be performed in a PDF document.</summary>
3837
[Native]
3938
[TV (18, 2)]
4039
public enum PdfActionNamedName : long {
@@ -65,7 +64,6 @@ public enum PdfActionNamedName : long {
6564
}
6665

6766
/// <summary>Enumerates annotation widget controls.</summary>
68-
/// <remarks>To be added.</remarks>
6967
[Native]
7068
[TV (18, 2)]
7169
public enum PdfWidgetControlType : long {
@@ -79,8 +77,7 @@ public enum PdfWidgetControlType : long {
7977
CheckBox = 2,
8078
}
8179

82-
/// <summary>Enumerates line ending styles</summary>
83-
/// <remarks>To be added.</remarks>
80+
/// <summary>Enumerates line ending styles.</summary>
8481
[Native]
8582
[TV (18, 2)]
8683
public enum PdfLineStyle : long {
@@ -98,8 +95,7 @@ public enum PdfLineStyle : long {
9895
ClosedArrow = 5,
9996
}
10097

101-
/// <summary>Indicates annotation markup types.</summary>
102-
/// <remarks>To be added.</remarks>
98+
/// <summary>Enumerates annotation markup types.</summary>
10399
[Native]
104100
[TV (18, 2)]
105101
public enum PdfMarkupType : long {
@@ -109,11 +105,11 @@ public enum PdfMarkupType : long {
109105
StrikeOut = 1,
110106
/// <summary>Indicates an underline markup.</summary>
111107
Underline = 2,
108+
/// <summary>Indicates a redaction markup.</summary>
112109
Redact = 3,
113110
}
114111

115112
/// <summary>Enumerates annotation icon types.</summary>
116-
/// <remarks>To be added.</remarks>
117113
[Native]
118114
[TV (18, 2)]
119115
public enum PdfTextAnnotationIconType : long {
@@ -134,7 +130,6 @@ public enum PdfTextAnnotationIconType : long {
134130
}
135131

136132
/// <summary>Enumerates annotation border styles.</summary>
137-
/// <remarks>To be added.</remarks>
138133
[Native]
139134
[TV (18, 2)]
140135
public enum PdfBorderStyle : long {
@@ -176,7 +171,6 @@ public enum PdfDocumentPermissions : long {
176171
}
177172

178173
/// <summary>Enumerates Adobe-specified PDF display box boundaries.</summary>
179-
/// <remarks>To be added.</remarks>
180174
[Native]
181175
[TV (18, 2)]
182176
public enum PdfDisplayBox : long {
@@ -192,8 +186,7 @@ public enum PdfDisplayBox : long {
192186
Art = 4,
193187
}
194188

195-
/// <summary>Enumerated PDF display modes.</summary>
196-
/// <remarks>To be added.</remarks>
189+
/// <summary>Enumerates PDF display modes.</summary>
197190
[Native]
198191
[TV (18, 2)]
199192
public enum PdfDisplayMode : long {
@@ -207,8 +200,7 @@ public enum PdfDisplayMode : long {
207200
TwoUpContinuous = 3,
208201
}
209202

210-
/// <summary>Orable flags that describe areas of interest for a touch position.</summary>
211-
/// <remarks>To be added.</remarks>
203+
/// <summary>Bitwise flags that describe areas of interest for a touch position.</summary>
212204
[Flags]
213205
[Native]
214206
[TV (18, 2)]
@@ -233,6 +225,7 @@ public enum PdfAreaOfInterest : long {
233225
PopupArea = 1 << 7,
234226
/// <summary>Indicates that the touch position is over an image.</summary>
235227
ImageArea = 1 << 8,
228+
/// <summary>Indicates that all areas of interest are included.</summary>
236229
[iOS (15, 0), MacCatalyst (15, 0)]
237230
AnyArea = Int64.MaxValue,
238231
}

tests/cecil-tests/Documentation.KnownFailures.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5811,8 +5811,6 @@ F:PdfKit.PdfAccessPermissions.DocumentChanges
58115811
F:PdfKit.PdfAccessPermissions.FormFieldEntry
58125812
F:PdfKit.PdfAccessPermissions.HighQualityPrinting
58135813
F:PdfKit.PdfAccessPermissions.LowQualityPrinting
5814-
F:PdfKit.PdfAreaOfInterest.AnyArea
5815-
F:PdfKit.PdfMarkupType.Redact
58165814
F:PdfKit.PdfSelectionGranularity.Character
58175815
F:PdfKit.PdfSelectionGranularity.Line
58185816
F:PdfKit.PdfSelectionGranularity.Word

0 commit comments

Comments
 (0)