Hi, The ES team will be writing documentation conforming to the JSDoc specification:
*Advantages*: - It is a standard specification used for documenting JS libraries - Can be used to auto generate documentation by using a parser [1] *Disadvantages:* - Requires fiddling with JSDoc notation to generate documentation for classes defined with the module pattern *Sample usage of JSDoc* RXT module documentation: https://github.com/wso2-dev/product-es/blob/master/modules/jaggery-modules/rxt/module/scripts/app/app.js *Reference* [1] JSDoc Parser , URL:https://github.com/jsdoc3/jsdoc <http://sharadchhetri.com/2013/08/02/how-to-install-mod_proxy-and-setup-reverse-proxy-in-apache-ubuntu/> Thank You, Sameera -- Sameera Medagammaddegedara Software Engineer Contact: Email: [email protected] Mobile: + 94 077 255 3005
_______________________________________________ Dev mailing list [email protected] http://wso2.org/cgi-bin/mailman/listinfo/dev
