Document the generate-externs.js task

This commit is contained in:
Andreas Hocevar
2014-07-31 17:50:43 +02:00
parent 4cb60feb40
commit 0d86e4a237

View File

@@ -89,6 +89,13 @@ The `defines` section of `build.json` above lists common settings for the Closur
Called internally to generate a `build/exports.js` file optionally with a limited set of exports.
## `generate-externs.js`
Can be called to generate a Closure externs file for the full OpenLayers 3 API. The externs file will be placed as `ol-externs.js` in the `build/` directory.
This is useful for projects that use the Closure Compiler to build, but want to use OpenLayers 3 as external library rather than building together with OpenLayers 3.
## `generate-info.js`
Called internally to parse the library for annotations and write out a `build/info.json` file.