In my last two posts about using DocC, I’ve been implicitly encouraging the use of the new docc-plugin for the Swift package manager. I did so knowing that it is in beta and the underlying APIs are evolving – and in my example scripts I include how to do the same thing with commands thatContinue reading “DocC plugin PSA”
Tag Archives: docc
Tips for getting the most out of DocC
1 – Start by adding doc comments to your types. The starting point is adding a single short summary sentence as comment (using the ///) for each public type in your library or app. Feel free to add more: if you add a “blank line” (meaning include another line with /// but nothing else inContinue reading “Tips for getting the most out of DocC”
Hosting your Swift Library Docs on Github Pages
The beta for Xcode 13.3 dropped yesterday. With it came a released version of Swift 5.6 and a bunch of neat additions that the 5.6 release enables. A feature I was watching closely was two-fold: the capability for plugins to extend the commands available within swift’s package manager, and a static hosting option that wasContinue reading “Hosting your Swift Library Docs on Github Pages”
Adding DocC to an existing swift package
During WWDC 21, Apple announced that they would be open sourcing documentation tooling (DocC) that’s used to build and provide documentation within Apple. At the tail end of October 2021, the initial version of DocC was released — available on Github, scattered through multiple repositories: swift-docc swift-docc-render swift-docc-symbolkit Apple hosts documentation about DocC (presumably writtenContinue reading “Adding DocC to an existing swift package”
Rhonabwy 