[infinispan-issues] [JBoss JIRA] (HRJS-16) Generate API docs for JS client

[Galder Zamarreño (JIRA)]

    [ https://issues.jboss.org/browse/HRJS-16?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13246368#comment-13246368 ] 

Galder Zamarreño commented on HRJS-16:
--------------------------------------

The best option out there seems to be to use JSDoc. I played a bit with it in this [branch|https://github.com/galderz/js-client/tree/t_16]

{code}
$ npm install jsdoc
$ ./node_modules/.bin/jsdoc lib/*.js
{code}

^ Executing that generates, on the minimal JSDoc added in the branch, generates some reasonably looking API docs, see attached screenshot.

> Generate API docs for JS client
> -------------------------------
>
>                 Key: HRJS-16
>                 URL: https://issues.jboss.org/browse/HRJS-16
>             Project: Infinispan Javascript client
>          Issue Type: Task
>            Reporter: Galder Zamarreño
>            Assignee: Galder Zamarreño
>             Fix For: 0.3.0
>
>
> We should generate API documentation for the JS client so that it is clear which API is available.



--
This message was sent by Atlassian JIRA
(v6.4.11#64026)