Re: [aerogear-dev] JS API Doc Updates

Thanks for the review! Comments inline. On Mar 26, 2013, at 3:47 AM, Matthias Wessendorf <matzew(a)apache.org&gt; 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?

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... 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.

4) match any example? http://staging.aerogear.org/docs/specs/aerogear-js/AeroGear.DataManager.a... Thanks! Will add. 5) no filter here: http://staging.aerogear.org/docs/specs/aerogear-js/AeroGear.DataManager.a... 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

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.adap... I'd prefer several smaller examples… I can look into breaking that up.

BTW... I like the links to the 'types' of the callbacks! On Mon, Mar 25, 2013 at 10:32 PM, Kris Borchers <kris(a)redhat.com&gt; 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_Fr0rsgusgjcwGhXFOnd2369KZgOYP9... > > Thanks! > > _______________________________________________ > aerogear-dev mailing list > aerogear-dev(a)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(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/aerogear-dev _______________________________________________ aerogear-dev mailing list aerogear-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/aerogear-dev