[aerogear-dev] JS API Doc Updates

[Matthias Wessendorf]

On Tue, Mar 26, 2013 at 1:54 PM, Kris Borchers <kris at redhat.com> wrote:

> Thanks for the review! Comments inline.
>
> On Mar 26, 2013, at 3:47 AM, Matthias Wessendorf <matzew at apache.org>
> wrote:
>
>
>
> 1) On the left, there is a link to
> http://staging.aerogear.org/docs/specs/aerogear-js/AeroGear.html
> not sure if this page should be linked, from the left nav...
> (since it's just a few (out of context?) functions/callbacks)
>
>
> On the left of what page?
>


oh - on the right :) (the other left :-))

Home <http://staging.aerogear.org/docs/specs/aerogear-js/index.html>
Namespaces

   - AeroGear<http://staging.aerogear.org/docs/specs/aerogear-js/AeroGear.html>





>
>
> 2) "var auth3 = AeroGear.Auth( [ "someAuth", "anotherAuth" ] );"
>  => add some with settings?
>
>
> Already covered in Google doc.
>
>
>
> 3) Not sure if it is clear _what_ is supported on the 'settings' (for
> Pipeline, DataManager, Auth)
> For instance, here it's better described what this 'settings', there
> supports:
>
> http://staging.aerogear.org/docs/specs/aerogear-js/AeroGear.Auth.adapters.Rest.html
>
>
> This is already addressed for Auth. Basically, those settings are
> determined by the adapter you're using so there is no way to specifically
> define them on Pipeline, DataManager or Auth. Auth says to refer to the
> adapter you are using for more details (though there is a typo). I will add
> that same sentence to the others.
>

I did assume that some magic is going on - but being explicit in the doc
does not hurt :)



>
>
>
> 4) match any example?
>
> http://staging.aerogear.org/docs/specs/aerogear-js/AeroGear.DataManager.adapters.Memory.html
>
>
> Thanks! Will add.
>
>
> 5) no filter here:
>
> http://staging.aerogear.org/docs/specs/aerogear-js/AeroGear.DataManager.adapters.SessionLocal.html
>
>
> This is a tougher one. There is no code in the sessionLocal adapter for
> filter since that adapter inherits from Memory. The "Mixes In" section is
> supposed to imply that the methods
>

:) I was imagine that - but would appreciate a concrete sencence - or at
least a way to link to that; (on java doc there is an inherited functions
section, with clickable links)


> in Memory are included in sessionLocal unless overridden by sessionLocal.
> I'll see if there is a way to get that method to show up in docs even
> though there is no code.
>
>
>
> 6) the read in here is pretty long (one long example)
>
> http://staging.aerogear.org/docs/specs/aerogear-js/AeroGear.Pipeline.adapters.Rest.html
>
> I'd prefer several smaller examples…
>
>
> I can look into breaking that up.
>

+1


>
>
> BTW... I like the links to the 'types' of the callbacks!
>
>
>
> On Mon, Mar 25, 2013 at 10:32 PM, Kris Borchers <kris at redhat.com> wrote:
>
>> Please take a look at http://staging.aerogear.org/docs/specs/aerogear-js/ and
>> let me know if you would like anything else updated, keeping in mind that
>> we are working on
>> https://docs.google.com/document/d/17J-qFm_Fr0rsgusgjcwGhXFOnd2369KZgOYP9kkwOlQ/edit
>>
>> Thanks!
>>
>> _______________________________________________
>> aerogear-dev mailing list
>> aerogear-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>>
>
>
>
> --
> Matthias Wessendorf
>
> blog: http://matthiaswessendorf.wordpress.com/
> sessions: http://www.slideshare.net/mwessendorf
> twitter: http://twitter.com/mwessendorf_______________________________________________
>
> aerogear-dev mailing list
> aerogear-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>
>
>
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>



-- 
Matthias Wessendorf

blog: http://matthiaswessendorf.wordpress.com/
sessions: http://www.slideshare.net/mwessendorf
twitter: http://twitter.com/mwessendorf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/aerogear-dev/attachments/20130326/3c0ee001/attachment.html