[OpenLayers-Dev] Re: OpenLayers API doc
Xavier Mamano (jorix)
xavier.mamano at gmail.com
Tue Aug 23 07:40:17 EDT 2011
I do not know if it can help. Long ago, thinking about the Closure Compiler,
I wrote a converter from NaturalDocs to JsDoc.
This converter is only concerned with aspects of the compiler, but can be a
starting point for a semi-automatic conversion to jsDoc (see
"tools/NaturalDocs2JsDoc.py" in #3008/cc-ol-compiler-3008.2.patch)
> Some of us among the OpenLayers devs have been contemplating the idea
> of offering a better API documentation for OpenLayers. With this email
> I'd like to gather comments, opinions, and ideas regarding the current
> API documentation, and what we should do to improve it.
> I've been looking at JsDoc lately. (Yes, I know we moved from JsDoc to
> NaturalDocs 4 years ago! ) Using JsDoc annotations would provide us
> with two things: (1) generate a nice API documentation using JsDoc
> Toolkit , and (2) fully benefit from the Google Closure compiler
> (code optimization, type checking, warnings, etc) . What I also
> find interesting about JsDoc is that it is a standard for annotating
> Any comment or experience is welcome! Thank you.
>  <http://code.google.com/p/jsdoc-toolkit/>
>  <https://github.com/visionmedia/dox>
> PS: I'm interested to work on that at the FOSS4G code sprint.
> Eric Lemoine
> Camptocamp France SAS
> Savoie Technolac, BP 352
> 73377 Le Bourget du Lac, Cedex
> Tel : 00 33 4 79 44 44 96
> Mail : eric.lemoine at camptocamp.com
> Dev mailing list
> Dev at lists.osgeo.org
View this message in context: http://osgeo-org.1803224.n2.nabble.com/OpenLayers-API-doc-tp6667194p6715805.html
Sent from the OpenLayers Dev mailing list archive at Nabble.com.
More information about the Dev