Hi Alvaro we looked at jsdoc3, we think it is a good tool and we will try to use it. Actually we will not put Javascript API documentation with the docs generated from Apiary on github: I think it will be difficult to mantain a separated template to get the same layout. We will put the documentation within the User and programmer's guide, since it is a small API. Then we will try to use jsDoc3 and import pages into wiki/readthedocs or whatever.... Thanks and best regards Davide Il 03/09/2015 17:56, Álvaro Arranz ha scritto: > Hi Davide, > > Release 3 of the WidgetAPI was created directly on the forge Wiki, it > was generated by hand as it was not a big API. Now I'm investigating > if is worth to use some documentation tool as Miguel answered me that > there is not going to be a template for JavaScript APIs. > > Kurento (StreamingOriented GE) have also a websocket API that cannot > be documented using APIary. They also provide some JavaScript > libraries, although I think they are not part of any of the > StreamOrientedGE open specs. Anyway, Miguel asked me to talk with them > to try to make our open specs documentation in a similar way... I sent > them an email, but I don't have an answer yet and also I don't know if > it's feasible to generate a similar documentation if they have to > document a websocket API... > > Do you plan to use any JavaScript documentation tool? What do you > think about jsdoc3 <https://github.com/jsdoc3/jsdoc>? > > Best regards, > Álvaro > > > On 3 September 2015 at 16:51, Davide Zerbetto <davide.zerbetto at eng.it > <mailto:davide.zerbetto at eng.it>> wrote: > > Hi all > I have a quick question regarding how to create documentation for > Javascript API. > since Apiary cannot be used for Javascript API, did you use a tool > for Javascript API or did you create documentation by hand? > Thanks and best regards > Davide > -- > > -- > > *Davide Zerbetto* > SpagoBI Consultant > > *SpagoBI Labs > Engineering Group* > Corso Stati Uniti, 23/C - 35127 Padua - Italy > Phone: +39 049 8283411 <tel:%2B39%20049%208283411> > Fax: +39-049.8700272 <tel:%2B39-049.8700272> > www.spagobi.org <http://www.spagobi.org> - www.eng.it > <http://www.eng.it/web/eng_en/home> > > > Respect the environment. Please don't print this e-mail unless > you really need to. > > The information transmitted is intended only for the person or > entity to which it is addressed and may contain confidential > and/or privileged material. Any review, retransmission, > dissemination or other use of, or taking of any action in reliance > upon, this information by persons or entities other than the > intended recipient is prohibited. If you received this in error, > please contact the sender and delete the material from any computer. > > > _______________________________________________ > Fiware-apps mailing list > Fiware-apps at lists.fi-ware.org <mailto:Fiware-apps at lists.fi-ware.org> > https://lists.fi-ware.org/listinfo/fiware-apps > > -- -- *Davide Zerbetto* SpagoBI Consultant *SpagoBI Labs Engineering Group* Corso Stati Uniti, 23/C - 35127 Padua - Italy Phone: +39 049 8283411 Fax: +39-049.8700272 www.spagobi.org <http://www.spagobi.org> - www.eng.it <http://www.eng.it/web/eng_en/home> Respect the environment. Please don't print this e-mail unless you really need to. The information transmitted is intended only for the person or entity to which it is addressed and may contain confidential and/or privileged material. Any review, retransmission, dissemination or other use of, or taking of any action in reliance upon, this information by persons or entities other than the intended recipient is prohibited. If you received this in error, please contact the sender and delete the material from any computer. -------------- next part -------------- An HTML attachment was scrubbed... URL: <https://lists.fiware.org/private/fiware-apps/attachments/20150904/530c999f/attachment.html> -------------- next part -------------- A non-text attachment was scrubbed... Name: not available Type: image/png Size: 3639 bytes Desc: not available URL: <https://lists.fiware.org/private/fiware-apps/attachments/20150904/530c999f/attachment.png> -------------- next part -------------- A non-text attachment was scrubbed... Name: not available Type: image/jpeg Size: 1379 bytes Desc: not available URL: <https://lists.fiware.org/private/fiware-apps/attachments/20150904/530c999f/attachment.jpe> -------------- next part -------------- A non-text attachment was scrubbed... Name: spagobi.png Type: image/png Size: 3639 bytes Desc: not available URL: <https://lists.fiware.org/private/fiware-apps/attachments/20150904/530c999f/attachment-0001.png> -------------- next part -------------- A non-text attachment was scrubbed... Name: image006.jpg Type: image/jpeg Size: 1379 bytes Desc: not available URL: <https://lists.fiware.org/private/fiware-apps/attachments/20150904/530c999f/attachment.jpg>
You can get more information about our cookies and privacy policies clicking on the following links: Privacy policy Cookies policy