Add docs for caja.js API

[ihab.awad, 2011-07-12 22:08:25]

Sorry, the 1st snapshot contained extraneous material. Pls ignore.

[Jasvir, 2011-07-12 22:28:19]

LGTM.

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/apidoc.js
File doc/cajajs/apidoc.js (right):

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/apidoc.js#newcode30
doc/cajajs/apidoc.js:30: var hc = el.getAttribute('hidecontrol');
:)

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/apidoc.js#newcode34
doc/cajajs/apidoc.js:34: console.log('encountered clickable ' + scope + ' - ' +
target);
Don't use 'console' without checking it's presence.

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/apidoc.xsl
File doc/cajajs/apidoc.xsl (right):

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/apidoc.xsl#newcode55
doc/cajajs/apidoc.xsl:55: <xsl:with-param name="ctx"><xsl:value-of
select="name"/></xsl:with-param>
Minor nit, wrap at 80 here and below.

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/cajajs.xml
File doc/cajajs/cajajs.xml (right):

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/cajajs.xml#newcode602
doc/cajajs/cajajs.xml:602: <name>mimeType</name>
Perhaps apply an "Optional" marker.  Defaults to 'text/html'

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/cajajs.xml#newcode608
doc/cajajs/cajajs.xml:608: <name>content</name>
Optional.

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/cajajs.xml#newcode673
doc/cajajs/cajajs.xml:673: <name>only</name>
Capitalize ONLY

[ihab.awad, 2011-07-12 22:51:01]

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/apidoc.js
File doc/cajajs/apidoc.js (right):

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/apidoc.js#newcode34
doc/cajajs/apidoc.js:34: console.log('encountered clickable ' + scope + ' - ' +
target);
On 2011/07/12 22:28:19, jasvir wrote:
> Don't use 'console' without checking it's presence.

Was debug cruft. Raptured.

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/apidoc.xsl
File doc/cajajs/apidoc.xsl (right):

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/apidoc.xsl#newcode55
doc/cajajs/apidoc.xsl:55: <xsl:with-param name="ctx"><xsl:value-of
select="name"/></xsl:with-param>
On 2011/07/12 22:28:19, jasvir wrote:
> Minor nit, wrap at 80 here and below.

Can't -- some output is whitespace sensitive. I tried to wrap wherever I could
get away with it, but that's not everywhere.

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/cajajs.xml
File doc/cajajs/cajajs.xml (right):

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/cajajs.xml#newcode602
doc/cajajs/cajajs.xml:602: <name>mimeType</name>
On 2011/07/12 22:28:19, jasvir wrote:
> Perhaps apply an "Optional" marker.  Defaults to 'text/html'

Ok, added that in the comments. Should eventually suport in the input schema,
but that should be part of a much more extensive upgrade.

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/cajajs.xml#newcode608
doc/cajajs/cajajs.xml:608: <name>content</name>
On 2011/07/12 22:28:19, jasvir wrote:
> Optional.

Same.

http://codereview.appspot.com/4714041/diff/3001/doc/cajajs/cajajs.xml#newcode673
doc/cajajs/cajajs.xml:673: <name>only</name>
On 2011/07/12 22:28:19, jasvir wrote:
> Capitalize ONLY

See feedback in your "builder caja.js" CL. This is a method and therefore should
be lowerCamelCase.

[Jasvir, 2011-07-12 22:58:14]

LGTM

[ihab.awad, 2011-07-12 23:19:28]

@4544