ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated Exports Files (markdown)

Éric Lemoine
2013-05-10 04:32:53 -07:00
parent cb1c36c7ca
commit 24537ce6eb
1 changed files with 17 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Exports-Files.md
+17 -1
@@ -32,7 +32,23 @@ All the (exported) constructors are _single-argument constructors_, they take on
target: 'map'
});
The constructors' options objects, and their properties, are declared in the `src/objectliterals.jsdoc` file. The options objects themselves are declared using the `@typedef` keyword, while properties are declared using the `@property` keyword.
The constructors' options objects, and their properties, are declared in the `src/objectliterals.jsdoc` file. The options objects themselves are declared using the `@typedef` keyword, while properties are declared using the `@property` keyword. This is, for example, how the `ol.Map` constructor's options are declared:
```
/**
* Object literal with config options for the map.
* @typedef {Object} ol.MapOptions
* @property {Array.<ol.control.Control>|undefined} controls Controls initially
* added to the map.
* @property {ol.Collection|undefined} interactions Interactions.
* @property {Array.<ol.layer.Layer>|ol.Collection|undefined} layers Layers.
* @property {ol.RendererHint|undefined} renderer Renderer.
* @property {Array.<ol.RendererHint>|undefined} renderers Renderers.
* @property {Element|string|undefined} target The container for the map.
* @property {ol.IView|undefined} view The map's view. Currently
* {@link ol.View2D} is available as view.
*/
```
This file is also processed with the `bin/generate-exports` script, but using the `--externs` and `--typedef` switches.