Updates to Swift Documentation Markup


Just submitted an updated version of Swift Documentation Markup to the iBooks and Leanpub stores. This new version includes revisions to my coverage of the excellent Jazzy documentation tool and new coverage of the VVDocumenter Xcode plugin, which automatically adds documentation templates to your code when you type ///.

Jazzy now supports some markup parsing, including parameters. Compare the output from the new version, shown here:

Screen Shot 2016-01-15 at 11.21.11 AM

with the old output here:Screen Shot 2016-01-15 at 10.09.27 AM

It’s a fantastic and welcome improvement.

The VVDocumenter works by adding documentation templates to any symbol when you type /// (three forward slashes) before its declaration.

Screen Shot 2016-01-15 at 10.20.07 AM

Just fill in the boilerplate with your details. VVDocumenter automatically adds placeholder tokens using <# and #> so they highlight in your source editor.

Note that as with any plug-in, you need to keep VVDocumenter up to date so it works with each revision and beta of Xcode.

Comments are closed.