Get Updates By E-mail 

Article Written By:
Johann Dowa

Tool: A Command Line Documentation Generator For Swift

  •  
  •  
  •  
  •  
  •  

Last week I mentioned a nice library for working with JSON in Swift as using the JSON parsing API’s in the iOS SDK can become tedious.

Documentation generation in Swift is another issue to be tackled, and at this point the popular Appledoc tool does not yet support Swift (support is coming in 3.0).

Here’s a command line tool for Swift users (also works with Objective-C) that you can use to quickly generate docs called Jazzy from Realm that aims to match the style of Apple’s documentation post WWDC 2014.

Keep in mind that at this point Jazzy only works with simple projects so if you try running it on an extensive project there could be issues. If you’re looking to document an extensive Objective-C project you should use Appledoc.

You can install Jazzy with:

sudo gem install jazzy

You can find the Jazzy project on Github here.

A nice easy way to generate documentation – you will need Xcode 6 beta to install the gem.


  •  
  •  
  •  
  •  
  •  

Submit A Resource

Have you created a useful tutorial, library or tool for iOS development that you would like to get in front of our 300,000+ monthly page views from iOS developers?

You can submit the url here.

The resources we feel will appeal to our readers the most will be posted on the front page.

Comments