Skip to content

Commit 85722c0

Browse files
committed
View Controllers: add some documentation comments
Clean up some documentation comments from the linter.
1 parent 7c73c67 commit 85722c0

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

Sources/SwiftWin32/View Controllers/ViewController.swift

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ public enum ModalTransitionStyle: Int {
1212
case partialCurl
1313
}
1414

15-
1615
/// Constants that specify the edges of a rectangle.
1716
public struct RectEdge: OptionSet {
1817
public typealias RawValue = UInt
@@ -263,6 +262,7 @@ public class ViewController: Responder {
263262
return self.modalPresentationStyle == .formSheet
264263
}
265264

265+
/// Posted when a split view controller is expanded or collapsed.
266266
public class var showDetailTargetDidChangeNotification: NSNotification.Name {
267267
NSNotification.Name(rawValue: "UIViewControllerShowDetailTargetDidChangeNotification")
268268
}
@@ -292,22 +292,29 @@ public class ViewController: Responder {
292292
}
293293

294294
extension ViewController: ContentContainer {
295+
/// Notifies the container that the size of its view is about to change.
295296
public func willTransition(to: Size,
296297
with coodinator: ViewControllerTransitionCoordinator) {
297298
}
298299

300+
/// Notifies the container that its trait collection changed.
299301
public func willTransition(to: TraitCollection,
300302
with coordinator: ViewControllerTransitionCoordinator) {
301303
}
302304

305+
/// Returns the size of the specified child view controller’s content.
303306
public func size(forChildContentContainer container: ContentContainer,
304307
withParentContainerSize parentSize: Size) -> Size {
305308
return .zero
306309
}
307310

311+
/// Notifies an interested controller that the preferred content size of one
312+
/// of its children changed.
308313
public func preferredContentSizeDidChange(forChildContentContainer container: ContentContainer) {
309314
}
310315

316+
/// Notifies the container that a child view controller was resized using auto
317+
/// layout.
311318
public func systemLayoutFittingSizeDidChange(forChildContentContainer container: ContentContainer) {
312319
}
313320
}

0 commit comments

Comments
 (0)