Skip to content

Commit c0a2940

Browse files
authored
[AppKit] Document ten AppKit enum types (#26539)
Document ten AppKit enum types and all their members: - `NSLineCapStyle` - `NSLineJoinStyle` - `NSWindingRule` - `NSRulerOrientation` - `NSSelectionAffinity` - `NSSelectionGranularity` - `NSLineSweepDirection` - `NSLineMovementDirection` - `NSPrintingOrientation` - `NSPrintingPaginationMode` Remove the corresponding entries from the Cecil documentation known-failures baseline. The batch contains one initial commit per type and stays within the 100-line change budget. 🤖 Pull request created by Copilot
1 parent 8c84647 commit c0a2940

2 files changed

Lines changed: 39 additions & 39 deletions

File tree

src/AppKit/Enums.cs

Lines changed: 39 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1879,34 +1879,37 @@ public enum NSSaveOperationType : ulong {
18791879

18801880
#region NSBezelPath
18811881

1882+
/// <summary>Specifies the shape of the endpoints of an open path.</summary>
18821883
[NoMacCatalyst]
18831884
[Native]
18841885
public enum NSLineCapStyle : ulong {
1885-
/// <summary>To be added.</summary>
1886+
/// <summary>Ends the path at the endpoint.</summary>
18861887
Butt,
1887-
/// <summary>To be added.</summary>
1888+
/// <summary>Uses a semicircular cap centered on the endpoint.</summary>
18881889
Round,
1889-
/// <summary>To be added.</summary>
1890+
/// <summary>Uses a square cap that extends beyond the endpoint.</summary>
18901891
Square,
18911892
}
18921893

1894+
/// <summary>Specifies the shape used to join connected path segments.</summary>
18931895
[NoMacCatalyst]
18941896
[Native]
18951897
public enum NSLineJoinStyle : ulong {
1896-
/// <summary>To be added.</summary>
1898+
/// <summary>Joins segments by extending their outer edges until they meet.</summary>
18971899
Miter,
1898-
/// <summary>To be added.</summary>
1900+
/// <summary>Joins segments with a rounded corner.</summary>
18991901
Round,
1900-
/// <summary>To be added.</summary>
1902+
/// <summary>Joins segments with a beveled corner.</summary>
19011903
Bevel,
19021904
}
19031905

1906+
/// <summary>Specifies the rule used to determine which areas of a path are filled.</summary>
19041907
[NoMacCatalyst]
19051908
[Native]
19061909
public enum NSWindingRule : ulong {
1907-
/// <summary>To be added.</summary>
1910+
/// <summary>Fills areas using the nonzero winding rule.</summary>
19081911
NonZero,
1909-
/// <summary>To be added.</summary>
1912+
/// <summary>Fills areas using the even-odd winding rule.</summary>
19101913
EvenOdd,
19111914
}
19121915

@@ -1926,12 +1929,13 @@ public enum NSBezierPathElement : ulong {
19261929
#endregion
19271930

19281931
#region NSRulerView
1932+
/// <summary>Specifies the orientation of a ruler view.</summary>
19291933
[NoMacCatalyst]
19301934
[Native]
19311935
public enum NSRulerOrientation : ulong {
1932-
/// <summary>To be added.</summary>
1936+
/// <summary>A horizontal ruler.</summary>
19331937
Horizontal,
1934-
/// <summary>To be added.</summary>
1938+
/// <summary>A vertical ruler.</summary>
19351939
Vertical,
19361940
}
19371941
#endregion
@@ -2133,23 +2137,25 @@ public enum NSUnderlinePattern : int {
21332137
DashDotDot = 0x0400,
21342138
}
21352139

2140+
/// <summary>Specifies the direction associated with a selection at a line boundary.</summary>
21362141
[NoMacCatalyst]
21372142
[Native]
21382143
public enum NSSelectionAffinity : ulong {
2139-
/// <summary>To be added.</summary>
2144+
/// <summary>The selection is associated with the preceding line.</summary>
21402145
Upstream,
2141-
/// <summary>To be added.</summary>
2146+
/// <summary>The selection is associated with the following line.</summary>
21422147
Downstream,
21432148
}
21442149

2150+
/// <summary>Specifies the unit used when modifying a text selection.</summary>
21452151
[NoMacCatalyst]
21462152
[Native]
21472153
public enum NSSelectionGranularity : ulong {
2148-
/// <summary>To be added.</summary>
2154+
/// <summary>Selects text by character.</summary>
21492155
Character,
2150-
/// <summary>To be added.</summary>
2156+
/// <summary>Selects text by word.</summary>
21512157
Word,
2152-
/// <summary>To be added.</summary>
2158+
/// <summary>Selects text by paragraph.</summary>
21532159
Paragraph,
21542160
}
21552161

@@ -2181,31 +2187,33 @@ public enum NSTrackingAreaOptions : ulong {
21812187
}
21822188
#endregion
21832189

2190+
/// <summary>Specifies the direction in which text layout sweeps across a line.</summary>
21842191
[NoMacCatalyst]
21852192
[Native]
21862193
public enum NSLineSweepDirection : ulong {
2187-
/// <summary>To be added.</summary>
2194+
/// <summary>Sweeps toward the left.</summary>
21882195
NSLineSweepLeft,
2189-
/// <summary>To be added.</summary>
2196+
/// <summary>Sweeps toward the right.</summary>
21902197
NSLineSweepRight,
2191-
/// <summary>To be added.</summary>
2198+
/// <summary>Sweeps downward.</summary>
21922199
NSLineSweepDown,
2193-
/// <summary>To be added.</summary>
2200+
/// <summary>Sweeps upward.</summary>
21942201
NSLineSweepUp,
21952202
}
21962203

2204+
/// <summary>Specifies the direction in which text layout moves between lines.</summary>
21972205
[NoMacCatalyst]
21982206
[Native]
21992207
public enum NSLineMovementDirection : ulong {
2200-
/// <summary>To be added.</summary>
2208+
/// <summary>Does not move between lines.</summary>
22012209
None,
2202-
/// <summary>To be added.</summary>
2210+
/// <summary>Moves to the left.</summary>
22032211
Left,
2204-
/// <summary>To be added.</summary>
2212+
/// <summary>Moves to the right.</summary>
22052213
Right,
2206-
/// <summary>To be added.</summary>
2214+
/// <summary>Moves downward.</summary>
22072215
Down,
2208-
/// <summary>To be added.</summary>
2216+
/// <summary>Moves upward.</summary>
22092217
Up,
22102218
}
22112219

@@ -2289,23 +2297,25 @@ public enum NSBitmapFormat : ulong {
22892297
BigEndian32Bit = 1 << 11,
22902298
}
22912299

2300+
/// <summary>Specifies the orientation of printed pages.</summary>
22922301
[NoMacCatalyst]
22932302
[Native]
22942303
public enum NSPrintingOrientation : ulong {
2295-
/// <summary>To be added.</summary>
2304+
/// <summary>Prints pages in portrait orientation.</summary>
22962305
Portrait,
2297-
/// <summary>To be added.</summary>
2306+
/// <summary>Prints pages in landscape orientation.</summary>
22982307
Landscape,
22992308
}
23002309

2310+
/// <summary>Specifies how printed content is paginated along one axis.</summary>
23012311
[NoMacCatalyst]
23022312
[Native]
23032313
public enum NSPrintingPaginationMode : ulong {
2304-
/// <summary>To be added.</summary>
2314+
/// <summary>Divides the content into equal-sized page rectangles.</summary>
23052315
Auto,
2306-
/// <summary>To be added.</summary>
2316+
/// <summary>Scales the content to produce one row or column of pages.</summary>
23072317
Fit,
2308-
/// <summary>To be added.</summary>
2318+
/// <summary>Clips the content to produce one row or column of pages.</summary>
23092319
Clip,
23102320
}
23112321

tests/cecil-tests/Documentation.KnownFailures.txt

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22527,10 +22527,6 @@ T:AppKit.NSLevelIndicatorPlaceholderVisibility
2252722527
T:AppKit.NSLevelIndicatorStyle
2252822528
T:AppKit.NSLineBreakMode
2252922529
T:AppKit.NSLineBreakStrategy
22530-
T:AppKit.NSLineCapStyle
22531-
T:AppKit.NSLineJoinStyle
22532-
T:AppKit.NSLineMovementDirection
22533-
T:AppKit.NSLineSweepDirection
2253422530
T:AppKit.NSMatrixMode
2253522531
T:AppKit.NSMenuItemBadgeType
2253622532
T:AppKit.NSMenuPresentationStyle
@@ -22580,9 +22576,7 @@ T:AppKit.NSPopoverBehavior
2258022576
T:AppKit.NSPopUpArrowPosition
2258122577
T:AppKit.NSPressureBehavior
2258222578
T:AppKit.NSPrinterTableStatus
22583-
T:AppKit.NSPrintingOrientation
2258422579
T:AppKit.NSPrintingPageOrder
22585-
T:AppKit.NSPrintingPaginationMode
2258622580
T:AppKit.NSPrintPanelOptions
2258722581
T:AppKit.NSPrintPanelResult
2258822582
T:AppKit.NSPrintRenderingQuality
@@ -22600,7 +22594,6 @@ T:AppKit.NSRulerEditorChildCriterion
2260022594
T:AppKit.NSRulerEditorDisplayValue
2260122595
T:AppKit.NSRulerEditorPredicateParts
2260222596
T:AppKit.NSRulerMarkerClientViewDelegation
22603-
T:AppKit.NSRulerOrientation
2260422597
T:AppKit.NSRulerViewUnits
2260522598
T:AppKit.NSRunResponse
2260622599
T:AppKit.NSSaveOperationType
@@ -22618,9 +22611,7 @@ T:AppKit.NSSegmentBackgroundStyle_NSSegmentedCell
2261822611
T:AppKit.NSSegmentDistribution
2261922612
T:AppKit.NSSegmentStyle
2262022613
T:AppKit.NSSegmentSwitchTracking
22621-
T:AppKit.NSSelectionAffinity
2262222614
T:AppKit.NSSelectionDirection
22623-
T:AppKit.NSSelectionGranularity
2262422615
T:AppKit.NSSharingCollaborationMode
2262522616
T:AppKit.NSSharingContentScope
2262622617
T:AppKit.NSSharingServiceAnchoringViewForSharingService
@@ -22800,7 +22791,6 @@ T:AppKit.NSViewResizingMask
2280022791
T:AppKit.NSVisualEffectBlendingMode
2280122792
T:AppKit.NSVisualEffectMaterial
2280222793
T:AppKit.NSVisualEffectState
22803-
T:AppKit.NSWindingRule
2280422794
T:AppKit.NSWindowAnimationBehavior
2280522795
T:AppKit.NSWindowApplicationPresentationOptions
2280622796
T:AppKit.NSWindowBackingLocation

0 commit comments

Comments
 (0)