docc

Produce rich API reference documentation and interactive tutorials for your Swift framework or package.

Documentation Structure

Essentials

• Documenting a Swift Framework or Package (documenting-a-swift-framework-or-package.md): Create developer documentation from in-source comments, add articles with code snippets,

Documentation Content

• Writing Symbol Documentation in Your Source Files (writing-symbol-documentation-in-your-source-files.md): Add reference documentation to your symbols that explains how to use them.
• Adding Supplemental Content to a Documentation Catalog (adding-supplemental-content-to-a-documentation-catalog.md): Include articles and extension files to extend your source documentation comments or provide supporting conceptual content.
• Linking to Symbols and Other Content (linking-to-symbols-and-other-content.md): Facilitate navigation between pages using links.
• Adding Code Snippets to your Content (adding-code-snippets-to-your-content.md): Create and include code snippets to illustrate and provide examples of how to use your API.
• Documenting API with Different Language Representations ([Documenting API with different language representations/documenting-api-with-different-language-representations.md](Documenting API with different language representations/documenting-api-with-different-language-representations.md)): Create documentation for API that's callable from more than one source language.

Structure and Formatting