Swift Documentation Markup
Minimum price
Suggested price

Swift Documentation Markup

About the Book

Nearly every modern language, including Swift, offers some kind of structured comment system that documents APIs for developers that consume them. The new Swift 2 structured documentation uses a mix of custom keywords and Markdown syntax to create a simple, easy-to-apply annotation tool. By leveraging this industry-standard tech, Apple opens up its structured documentation system to an entirely new generation with an absolute minimum of training needed to get up to speed.

This short book introduces Swift's documentation markup system using simple, illustrated examples, with plenty of discussion of best practices. You'll discover the components that make up Swift's structured comment system and learn how to best integrate them into your own code. For the most part, I've built this material out of examples from Swift's standard library, from release notes, and by reverse-engineering extensible style-sheet specifications. While I've tried to include a thorough list of legal tokens, I've focused on supplementing core details with a thoughtful discussion of best practices that will stand the test of time as Apple updates this system.

I hope you find this book to be a useful and worthy addition to your development library. I've had a great time writing it. Hopefully you'll have a great time reading it. Thank you for purchasing a copy!


1.2 Added CommonMark update, updated playground section, added coverage of video embedding, added various tweaks and enhancements based on material found in Apple's open source content.

1.1.7 Added note about upcoming 7.3 Playground Doc keywords (experiment, note, and important) plus link to blog coverage.

1.1.6 Added coverage of Xcode 7.3/Swift 2.2's new keywords (recommended, recommendedover, keyword)

1.1.5 Expanded guidelines with Apple's updated API Design Guidelines document. There isn't a big difference beyond using "s" at the end of verbs when writing descriptions.

1.1.4 Added coverage of VVDocumenter's Xcode plug-in, updated Jazzy coverage

1.1.3 Errata fixes. Thank you Juan Diego.

1.1.2 Minor updates after Swift open sourced with API guidelines incorporated into a couple of discussions.

1.1.1 Added revision history (thanks, Adolofo Vera Blasco)

1.1.0 Major additions include expanded markup discussions, third party tool overviews, playground rich text documents: approximately 30% additional content.

1.0.1 Minor style fixes

  • Share this book

  • Categories

    • Computers and Programming
    • Software
  • Installments completed

    1 / 1

  • Feedback

    Email the Author(s)

About the Author

erica sadun
erica sadun

Erica Sadun writes lots of books. When not writing, she's a full time parent of geeks who are brushing up on their world domination skills. According to her academic dosimeter, she's acquired more education than any self-respecting person might consider wise. She enjoys deep diving into technology and has written, co-written, and contributed to dozens of books about computing and digital media. Sadun has blogged at TUAW, Ars Technica, O'Reilly, and Lifehacker. If you have any comments or questions about her ebooks, please drop an email at erica@ericasadun.com. Follow the author on her blog and Twitter (@ericasadun) to keep up with news and ebook announcements

Bundles that include this book

Bought separately
Bundle Price

Table of Contents

What is Structured Documentation?

What is Quick Help?

How Do Structured Documents Work?

Building Structured Documentation

Building Content with Markdown

Markup Cheat Sheet

Adding Symbol Section Commands

Adding Symbol Description Field Labels

Structured Documentation Cheat Sheet

Practical Considerations

Helpful Tools

Playground Markup


The Leanpub 60 Day 100% Happiness Guarantee

Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.

Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.

You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!

So, there's no reason not to click the Add to Cart button, is there?

See full terms...

80% Royalties. Earn $16 on a $20 book.

We pay 80% royalties. That's not a typo: you earn $16 on a $20 sale. If we sell 5000 non-refunded copies of your book or course for $20, you'll earn $80,000.

(Yes, some authors have already earned much more than that on Leanpub.)

In fact, authors have earnedover $13 millionwriting, publishing and selling on Leanpub.

Learn more about writing on Leanpub

Free Updates. DRM Free.

If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).

Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.

Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.

Learn more about Leanpub's ebook formats and where to read them

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!

Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.

Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF and/or EPUB files and then publish with one click!) It really is that easy.

Learn more about writing on Leanpub