Hi team,
we are currently in the process of cleaning up and improving iOS documentation. For better
visibility, we are integrating the API usage guide found here [1] inside (generated from
code) API docs [2].
The question is where we should put the "example code". For this, there are two
approaches, either collect and put them all in the header of the file with different
sections[3] or inline with the function [4].
wdyt?
-
Christos
[1]
https://github.com/aerogear/aerogear-ios/blob/master/API.md
[2]
http://aerogear.org/docs/specs/aerogear-ios/
[3]
http://tinyurl.com/cdldzh9
[4]
http://tinyurl.com/cjhg5ke