Hi,
There is existing tooling to generate API reference doc for
Android and iOS. I'm thinking we should use that to generate
comprehensive API doc for both platforms (and later for Cordova).
I believe this gives the best experience to the <platform>
developer, on the basis that, at any one time, they developer is
working on a single platform (and typically a colleague is
developing the 'other' platform). The disadvantages of this
approach include the fact that the appearance of generic
docs/android/ios will all be different, but we can put enough
navigation into the html to allow users enter and exit this
reference without too much pain.
However there is also a requirement to show the cross platform
nature of mobile-next, to demonstrate the generic nature of a
particular call. I'd like to address this, not in the 'full' API
docs, but in examples of typical use cases which might look like
getSyncClient().list("tasks");
For more information see <link to android ref docs>
syncClient.listWithDataId("tasks")For more information see <link to ios ref docs>
-- Paul Wright Mobile Docs (github: finp)
--
You received this message because you are subscribed to the Google Groups "Aerogear" group.
To unsubscribe from this group and stop receiving emails from it, send an email to aerogear+unsubscribe@googlegroups.com.
To post to this group, send email to aero...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/aerogear/5749d108-985c-250a-422c-27fbaa7c3e91%40redhat.com.
For more options, visit https://groups.google.com/d/optout.
To view this discussion on the web visit https://groups.google.com/d/msgid/aerogear/CAO0%2Bn%2BqgokrQtTqd6B1Oab-upe-C5PUvJh0evyJG9Z_LPd1ArQ%40mail.gmail.com.
Hi John,
Given that we want to document in asciidoc, I'm suggesting that we (somehow) use the same technique as used here to display alternative syntax (maven and gradle tabs):
This technique is based on the following asciidoctor extension:
https://github.com/spring-io/spring-asciidoctor-extensions
Just need to figure out how to include that in our publishing process,
Paul