/SwiftSymbolDocMarkupExamples

Swift code base that uses and illustrates the various Markup options to create symbol documentation.

Primary LanguageSwiftMIT LicenseMIT

SwiftSymbolDocMarkupExamples

A Swift code base that uses and illustrates the various Markup options to create symbol documentation.

Mega Example

Motivation

Provide a comprehensive and up-to-date reference guide for symbol documentation that is complementary to Markup Formatting Reference (outdated & sometimes incorrect) and Formatting your documentation content article.

Hosted documentation (generated by DocC)

Click here

Visualization

Tip: Read my blog post The visual reference guide for documenting your Swift code for nice comparison between markup use and its visualization in DoC-generated documentation and Xcode's Quick Help