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

Support DocC in Xcode 13 #477

Open
2 of 4 tasks
mpdifran opened this issue Jul 2, 2021 · 1 comment
Open
2 of 4 tasks

Support DocC in Xcode 13 #477

mpdifran opened this issue Jul 2, 2021 · 1 comment

Comments

@mpdifran
Copy link
Member

mpdifran commented Jul 2, 2021

Apple introduced a new standard for method documentation in Xcode 13. We're already doing a pretty good job of documenting things, so there's only a few small tweaks we need to make to support it fully.

TODO:

  • Build DocC on every build of the framework
  • Update method doc formats to better take advantage of DocC
  • Package DocC archives with the framework
  • Create tutorials for common patterns in DocC
@mpdifran
Copy link
Member Author

mpdifran commented Jul 2, 2021

A good article on using DocC in open source projects https://www.jessesquires.com/blog/2021/06/29/apple-docc-great-but-useless-for-oss

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

1 participant