How to link to native type extensions in DocC

Mar 21, 2024 · Follow on Twitter and Mastodon swift

In this post, we’ll take a look at how we can use Xcode 15’s improved 15 DocC capabilities to link to native type extensions, which lets us provide even better documentation.

Background

DocC provides a seemless and powerful way to document your source code, in a way that makes the public APIs of your code easily discovered.

DocC can be browsed directly within Xcode 15, exported to a documentation archive, and even exported to HTML and hosted on e.g. GitHub Pages.

While DocC was already great, Xcode 15 made it even better. You can now use metadata to describe your pages, create interactive tabs and grids, and much more.

Also new is the support to show and link to native type extensions, which was not possible in Xcode 14 and earlier. Let’s take a look at how this works.

Xcode 15 DocC extension support

If your code has extensions to native types, like String or SwiftUI View, Xcode 15 will add links to all extended modules at the bottom of your documentation root:

DocC links to extended frameworks

You can tap on any link to navigate to a page that lists all extended types in that module:

DocC links to extended types

You can then tap on any type to navigate to a page that lists all extensions for that type:

DocC extended type documentation

These are all amazing additions in their own respect, but what’s even better is that you can link to any extended type, as well as any extension, directly from your documentation.

As you can see in the first screenshot above, DocC will add links to extended modules to the bottom of the documentation root page.

In the the screenshot, you can also see links to deprecated types above the module links. DocC will obviously place deprecations before module extensions by default.

To fix this, we can manually add links to the extended modules to a manually curated topic sections, by adding a ### header followed by the module links:

### Extensions

- ``CoreFoundation``
- ``Foundation``
- ``Speech``
- ``Swift``
- ``SwiftUI``
- ``UIKit``

This lets you place the extensions at a more discoverable place within your documentation:

DocC links to extended types

You can use the same approach to link to an extended module in inline text, for instance:

This SDK adds a bunch of view extensions to ``SwiftUI``.

or a certain extended type:

This SDK adds a bunch extensions to ``SwiftUI/View``.

You can also link directly to a certain extension:

Toolbars can be styled with the ``SwiftUI/View/toolbarStyle(_:)`` view modifier.

These links will compile with the rest of your documentation, which gives you compile-time warnings if you remove an extension without updating the documentation.

Conclusion

Since many SDKs provide SDK-specific extensions to native types, Xcode 15’s native type extension support is a massive improvement to an already amazing documentation engine.

Being able to link to extended modules, types, and individual extensions makes it possible to create even better documentation for your users.

And since the extension documentation is compiled, removing extensions without updating your documentation will finally give you compile-time warnings for outdated references.

Discussions

Please share any ideas, feedback or comments you may have in the Disqus section below, or by replying to this tweet or this toot.

Follow for more

If you found this interesting, follow the Twitter and Mastodon accounts for more content like this, and to be notified when new content is published.