<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<p>Hi,</p>
<p>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).
<br>
</p>
<p>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.<br>
</p>
<p>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 <br>
</p>
<pre class="programlisting language-java" style="box-sizing: border-box; overflow: auto; font-family: Consolas, Monaco, "Andale Mono", monospace; font-size: 13px; display: block; padding: 0.9375rem; margin: 0px 0px 1.8em; line-height: 1.5; word-break: normal; word-wrap: normal; color: rgb(240, 240, 240); background: rgb(37, 37, 37); border: 1px solid rgb(26, 26, 26); border-radius: 0px; white-space: pre !important; text-shadow: none; direction: ltr; text-align: left; word-spacing: 0px; tab-size: 4; hyphens: none; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span class="token function" style="box-sizing: border-box; color: rgb(183, 230, 178); padding-left: 0px; background: none;">getSyncClient</span><span class="token punctuation" style="box-sizing: border-box; color: rgb(153, 153, 153); padding-left: 0px; background: none;">(</span><span class="token punctuation" style="box-sizing: border-box; color: rgb(153, 153, 153); padding-left: 0px; background: none;">)</span><span class="token punctuation" style="box-sizing: border-box; color: rgb(153, 153, 153); padding-left: 0px; background: none;">.</span><span class="token function" style="box-sizing: border-box; color: rgb(183, 230, 178); padding-left: 0px; background: none;">list</span><span class="token punctuation" style="box-sizing: border-box; color: rgb(153, 153, 153); padding-left: 0px; background: none;">(</span><span class="token string" style="box-sizing: border-box; color: rgb(150, 203, 228); padding-left: 0px; background: none;">"tasks"</span><span class="token punctuation" style="box-sizing: border-box; color: rgb(153, 153, 153); padding-left: 0px; background: none;">)</span><span class="token punctuation" style="box-sizing: border-box; color: rgb(153, 153, 153); padding-left: 0px; background: none;">;</span><span class="token function" style="box-sizing: border-box; color: rgb(183, 230, 178); padding-left: 0px; background: none;"></span></pre>
<p>For more information see <link to android ref docs></p>
<pre class="programlisting language-swift" style="box-sizing: border-box; overflow: auto; font-family: Consolas, Monaco, "Andale Mono", monospace; font-size: 13px; display: block; padding: 0.9375rem; margin: 0px 0px 1.8em; line-height: 1.5; word-break: normal; word-wrap: normal; color: rgb(240, 240, 240); background: rgb(37, 37, 37); border: 1px solid rgb(26, 26, 26); border-radius: 0px; white-space: pre !important; text-shadow: none; direction: ltr; text-align: left; word-spacing: 0px; tab-size: 4; hyphens: none; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">syncClient<span class="token punctuation" style="box-sizing: border-box; color: rgb(153, 153, 153); padding-left: 0px; background: none;">.</span><span class="token function" style="box-sizing: border-box; color: rgb(183, 230, 178); padding-left: 0px; background: none;">listWithDataId</span><span class="token punctuation" style="box-sizing: border-box; color: rgb(153, 153, 153); padding-left: 0px; background: none;">("tasks"</span><span class="token constant" style="box-sizing: border-box; color: rgb(220, 103, 94); padding-left: 0px; background: none;"></span><span class="token punctuation" style="box-sizing: border-box; color: rgb(153, 153, 153); padding-left: 0px; background: none;">)
</span></pre>
For more information see <link to ios ref docs><br>
<br>
<br>
WDYT?<br>
<pre class="moz-signature" cols="72">
--
Paul Wright
Mobile Docs (github: finp)</pre>
</body>
</html>