Writing documentation

Overview

The DocC documentation compiler converts Markdown-based text into rich documentation for Swift and Objective-C frameworks, packages, and apps to display in Xcode’s documentation window or host on a website.

DocC syntax — called documentation markup — is a custom variant of Markdown that adds functionality for developer documentation-specific features, like cross-symbol linking, term-definition lists, code listings, and asides. You add documentation markup to your source code, use Xcode’s Build Documentation feature to compile it with DocC, and produce reference documentation for your APIs. You can also use documentation markup, along with a set of directives that instruct how DocC generates your content, to offer step-by-step tutorials that teach developers to use your APIs through interactive coding exercises.

For a deeper understanding of DocC and guidance on its usage, please consult the DocC documentation available at DocC Swift.org.

[Image]

Topics

Essentials

• Documenting apps, frameworks, and packages

Documentation content

• Writing symbol documentation in your source files
• Adding supplemental content to a documentation catalog
• SlothCreator: Building DocC documentation in Xcode

Structure and formatting

• Adding structure to your documentation pages

Distribution

• Distributing documentation to other developers