Swift DocC API reference documentation

This skill covers the syntax and conventions for writing API reference documentation with Swift DocC—from in-source documentation comments to curated .docc documentation catalogs, topic hierarchies, symbol graphs, and Xcode agent skills integration.

References

• references/doc-comments-standard.md: Consult when authoring or reviewing in-source triple-slash (///) doc comments, writing single-sentence summaries, structuring parameter/return/throws tags, or formatting callout blocks.
• references/symbol-curation-and-extensions.md: Consult when curating target landing pages, defining ## Topics hierarchies, creating documentation extension files (Extensions/<Type>.md), or resolving symbol links and overload disambiguations.
• references/article-and-metadata-directives.md: Consult when configuring @Metadata blocks, @TechnologyRoot, URL redirection with @Redirected, multi-column grid layouts with @Row and @Column, or language switchers with @TabNavigator.

1. In-source documentation comments

Swift DocC extracts API reference documentation directly from doc comments attached to declarations in your Swift source code.

Comment syntax

• Always prefer triple slashes (///) over block comments (/** ... */). Triple slashes blend cleanly with standard Swift source code formatting.
• Attach the doc comment immediately preceding the declaration with no blank line in between.