Creating rich documentation with JSDoc
In our last example, we will automatically create documentation for OpenLayers 3. As we saw in ellipsoid.js, the headers resemble to the structure of the API documentation. The explanation is simple: Closure Compiler and JSDoc use the same headers to compile the library and create documentation for them. When we extended the constructor and the vincentyDsitance method with the @api tag, we not only make them exportable but also define that they should appear in the API documentation.
JSDoc is defined as an OpenLayers 3 dependency; therefore, it can be found in the node_modules folder. We will use it to generate documentation for our customized version. It also needs a configuration file, which is different from the one used for compiling. The default JSDoc configuration file can also be found in the config folder (config/jsdoc/api/conf.json). First, let's create a documentation with the default configuration file. For this, type the following command...
