Under the Bridge


This looks like a pretty easy way to generate Apple-styled documentation from Markdown type comments in your code, if you have a need for doing that kind of thing:

appledoc – Objective C API documentation generator

appledoc is command line tool that helps Objective-C developers generate Apple-like source code documentation from specially formatted source code comments. It’s designed to take as readable source code comments as possible for the input and use comments as well as surrounding source code to generate visually appealing documentation in the form of HTML as well as fully indexed and browsable Xcode documentation set. Although there are several tools that can create HTML documentation for Objective-C, all of those know to me fall short in meeting the minimum of goals described in appledoc’s readme file. Check example documentation to see what you can get!

Certainly looks vastly superior to any of the tools we’ve ever used for that kind of thing; however, we haven’t had to deal with that SDK-documenting kind of task for several years now. Anything you use that you consider a superior solution to the above, Dear Readers?

h/t: @alanQuatermain!


Auto Doc: Continuous Documentation Integration with appledoc + Jenkins