Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SR-9329] Dispatch overlay desperately needs documentation #632

Open
lilyball mannequin opened this issue Nov 23, 2018 · 2 comments
Open

[SR-9329] Dispatch overlay desperately needs documentation #632

lilyball mannequin opened this issue Nov 23, 2018 · 2 comments

Comments

@lilyball
Copy link
Mannequin

lilyball mannequin commented Nov 23, 2018

Previous ID SR-9329
Radar None
Original Reporter @lilyball
Type Bug
Environment

Apple Swift version 4.2.1 (swiftlang-1000.11.42 clang-1000.11.45.1)
Target: x86_64-apple-darwin18.2.0

Additional Detail from JIRA
Votes 0
Component/s libdispatch
Labels Bug
Assignee None
Priority Medium

md5: 69b16d2b08ab13c98778faa201c655b8

Issue Description:

The Dispatch overlay is almost completely lacking in documentation. This makes it very aggravating to use.

@lilyball
Copy link
Mannequin Author

lilyball mannequin commented Nov 23, 2018

It turns out that at least some parts of the overlay have doc comments, but the documentation is missing from Apple's Docset. I don't know what the process is for getting Swift overlay documentation into Apple's Docset.

For example, the DispatchSourceTimer schedule methods all have extensive documentation comments, but no documentation at all in Apple's Docset.

@belkadan
Copy link

cc @natecook1000

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant