| From | Sent On | Attachments |
|---|---|---|
| Dave | Nov 10, 2008 2:18 pm |
| Subject: | OK to commit JSDocToolkit? | |
|---|---|---|
| From: | Dave (snoo...@gmail.com) | |
| Date: | Nov 10, 2008 2:18:08 pm | |
| List: | net.java.dev.socialsite.dev | |
JSDoc can generate JavaDoc-like documentation for a JavaScript API, Google uses it for the OpenSocial docs and we use the markup too, in most our JavaScript API code. I have JSDocToolkit working against the SocailSite JavaScript API and the output looks pretty good.
Does anybody object to my committing the required JSDoc jars and adding JavaScript doc generation to our 'dist' build target?
JSDoc and the separate Ant task introduce two build-time only dependencies:
1) JSDocToolkit http://jsdoctoolkit.org MIT license
2) JSDocToolkit Ant Task http://code.google.com/p/jsdoc-toolkit-ant-task dual licensed under GPL and the Artistic License
I don't think we'll have a problem getting these past our internal review process because 1) MIT and Artistic are CDDL friendly and 2) it's a build time dependency only; there's no need to include these jars in a binary release.
- Dave





