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

Fix jsdoc formating

Browse Source
This commit is contained in:
Frederic Junod
2013-09-24 11:47:55 +02:00
parent 2610e9e0c3
commit ef929e9a72
13 changed files with 35 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
src/objectliterals.jsdoc
View File

@@ -77,7 +77,7 @@
/**
* Object literal with config options for the Proj4js projection.
* @typedef {Object} ol.Proj4jsProjectionOptions
* @property {string} code The SRS identifier code, e.g. 'EPSG:31256'.
* @property {string} code The SRS identifier code, e.g. `EPSG:31256`.
* @property {ol.Extent|undefined} extent The validity extent for the SRS.
* @property {boolean|undefined} global Whether the projection is valid for the
* whole globe. Default is false.
@@ -86,11 +86,11 @@
/**
* Object literal with config options for the projection.
* @typedef {Object} ol.ProjectionOptions
* @property {string} code The SRS identifier code, e.g. 'EPSG:4326'.
* @property {string} code The SRS identifier code, e.g. `EPSG:4326`.
* @property {ol.proj.Units} units Units.
* @property {ol.Extent|undefined} extent The validity extent for the SRS.
* @property {string|undefined} axisOrientation The axis orientation as
* specified in Proj4. The default is 'enu'.
* specified in Proj4. The default is `enu`.
* @property {boolean|undefined} global Whether the projection is valid for the
* whole globe. Default is false.
*/
@@ -161,7 +161,7 @@
/**
* @typedef {Object} ol.control.AttributionOptions
* @property {string|undefined} className CSS class name. Default is 'ol-attribution'.
* @property {string|undefined} className CSS class name. Default is `ol-attribution`.
* @property {Element|undefined} target Target.
*/
@@ -184,31 +184,31 @@
/**
* @typedef {Object} ol.control.FullScreenOptions
* @property {string|undefined} className CSS class name. Default is 'ol-full-screen'.
* @property {string|undefined} className CSS class name. Default is `ol-full-screen`.
* @property {boolean|undefined} keys Full keyboard access.
* @property {Element|undefined} target Target.
*/
/**
* @typedef {Object} ol.control.LogoOptions
* @property {string|undefined} className CSS class name. Default is 'ol-logo'.
* @property {string|undefined} className CSS class name. Default is `ol-logo`.
* @property {Element|undefined} target Target.
*/
/**
* @typedef {Object} ol.control.MousePositionOptions
* @property {string|undefined} className CSS class name. Default is 'ol-mouse-position'.
* @property {string|undefined} className CSS class name. Default is `ol-mouse-position`.
* @property {ol.CoordinateFormatType|undefined} coordinateFormat Coordinate
* format.
* @property {ol.proj.ProjectionLike} projection Projection.
* @property {Element|undefined} target Target.
* @property {string|undefined} undefinedHTML Markup for undefined coordinates.
* Default is '' (empty string).
* Default is `` (empty string).
*/
/**
* @typedef {Object} ol.control.ScaleLineOptions
* @property {string|undefined} className CSS Class name. Default is 'ol-scale-line'.
* @property {string|undefined} className CSS Class name. Default is `ol-scale-line`.
* @property {number|undefined} minWidth Minimum width in pixels.
* @property {Element|undefined} target Target.
* @property {ol.control.ScaleLineUnits|undefined} units Units.
@@ -216,7 +216,7 @@
/**
* @typedef {Object} ol.control.ZoomOptions
* @property {string|undefined} className CSS class name. Default is 'ol-zoom'.
* @property {string|undefined} className CSS class name. Default is `ol-zoom`.
* @property {number|undefined} delta The zoom delta applied on each click.
* @property {Element|undefined} target Target.
*/
@@ -230,7 +230,7 @@
/**
* @typedef {Object} ol.control.ZoomToExtentOptions
* @property {string|undefined} className Class name.
* @property {string|undefined} className Class name. Default is `ol-zoom-extent`.
* @property {Element|undefined} target Target.
* @property {ol.Extent|undefined} extent The extent to zoom to. If
* undefined the validity extent of the view projection is used.
@@ -466,8 +466,8 @@
* @property {string|undefined} creator The creator attribute to be added to
* the written GPX files. Defaults to `OpenLayers´.
* @property {string|undefined} defaultDesc Default description for the
* waypoints/tracks in the case where the feature has no 'description'
* attribute. Default is 'No description available'.
* waypoints/tracks in the case where the feature has no `description`
* attribute. Default is `No description available`.
* @property {boolean|undefined} extractAttributes Should we extract attributes
* from the GPX? Default is `true´.
* @property {boolean|undefined} extractWaypoints Extract waypoints from GPX.
@@ -518,8 +518,8 @@
* @property {ol.source.WMSGetFeatureInfoOptions|undefined}
* getFeatureInfoOptions Options for GetFeatureInfo.
* @property {Object.<string,*>} params WMS request parameters. At least a
* `LAYERS` param is required. `STYLES` is '' by default. `VERSION` is
* '1.3.0' by default. `WIDTH`, `HEIGHT`, `BBOX` and `CRS` (`SRS` for WMS
* `LAYERS` param is required. `STYLES` is `` by default. `VERSION` is
* `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX` and `CRS` (`SRS` for WMS
* version < 1.3.0) will be set dynamically.
* @property {ol.proj.ProjectionLike} projection Projection.
* @property {number|undefined} ratio Ratio. 1 means image requests are the size
@@ -570,8 +570,8 @@
* @typedef {Object} ol.source.TileWMSOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {Object.<string,*>} params WMS request parameters. At least a
* `LAYERS` param is required. `STYLES` is '' by default. `VERSION` is
* '1.3.0' by default. `WIDTH`, `HEIGHT`, `BBOX` and `CRS` (`SRS` for WMS
* `LAYERS` param is required. `STYLES` is `` by default. `VERSION` is
* `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX` and `CRS` (`SRS` for WMS
* version < 1.3.0) will be set dynamically.
* @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests.
@@ -634,7 +634,7 @@
* encoding.
* @property {string} layer Layer.
* @property {string} style Style.
* @property {string|undefined} version WMTS version. Default to '1.0.0'.
* @property {string|undefined} version WMTS version. Default to `1.0.0`.
* @property {string|undefined} format Format.
* @property {string} matrixSet Matrix set.
* @property {Object|undefined} dimensions Dimensions.
@@ -659,8 +659,8 @@
* @property {ol.TileUrlFunctionType|undefined} tileUrlFunction Optional
* function to get tile URL given a tile coordinate and the projection.
* Required if url or urls are not provided.
* @property {string|undefined} url URL template. Must include '{x}', '{y}',
* and '{z}' placeholders.
* @property {string|undefined} url URL template. Must include `{x}`, `{y}`,
* and `{z}` placeholders.
* @property {Array.<string>|undefined} urls An array of URL templates.
*/

2
src/ol/control/attributioncontrol.js
View File

@@ -18,7 +18,7 @@ goog.require('ol.css');
* Create a new attribution control to show all the attributions associated
* with the layer sources in the map. A default map has this control included.
* By default it will show in the bottom right portion of the map, but it can
* be changed by using a css selector for .ol-attribution.
* be changed by using a css selector for `.ol-attribution`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.AttributionOptions=} opt_options Attribution options.

2
src/ol/control/logocontrol.js
View File

@@ -14,7 +14,7 @@ goog.require('ol.css');
* Shows a logo for all the layer sources in the map that have a logo
* associated with them, such as Bing. This control is part of a default map.
* By default it will show in the bottom-left portion of the map, but it can
* be styled by using a css selector for .ol-logo.
* be styled by using a css selector for `.ol-logo`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.LogoOptions=} opt_options Logo options.

2
src/ol/control/mousepositioncontrol.js
View File

@@ -32,7 +32,7 @@ ol.control.MousePositionProperty = {
* Create a new control to show the position of the mouse in the map's
* projection (or any other supplied projection). By default the control is
* shown in the top right corner of the map but this can be changed by using
* a css selector .ol-mouse-position.
* a css selector `.ol-mouse-position`.
*
* @constructor
* @extends {ol.control.Control}

2
src/ol/control/scalelinecontrol.js
View File

@@ -42,6 +42,8 @@ ol.control.ScaleLineUnits = {
/**
* Create a control to help users estimate distances on a map.
* By default it will show in the bottom left portion of the map, but it can
* be changed by using a css selector for `.ol-scale-line`.
*
* @constructor
* @extends {ol.control.Control}

2
src/ol/control/zoomcontrol.js
View File

@@ -22,7 +22,7 @@ ol.control.ZOOM_DURATION = 250;
/**
* Create a new control with 2 buttons, one for zoom in and one for zoom out.
* This control is part of the default controls of a map. To style this control
* use css selectors .ol-zoom-in and .ol-zoom-out.
* use css selectors `.ol-zoom-in` and `.ol-zoom-out`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomOptions=} opt_options Zoom options.

2
src/ol/control/zoomtoextentcontrol.js
View File

@@ -14,7 +14,7 @@ goog.require('ol.css');
/**
* Create a control that adds a button, which, when pressed, changes
* the map view to a specific extent. To style this control use the
* css selector .ol-zoom-extent.
* css selector `.ol-zoom-extent`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomToExtentOptions=} opt_options Options.

3
src/ol/coordinate.js
View File

@@ -7,13 +7,14 @@ goog.require('goog.math');
/**
* A function that formats a {@link ol.Coordinate} into a string.
* @typedef {function((ol.Coordinate|undefined)): string}
*/
ol.CoordinateFormatType;
/**
* An array representing a coordinate.
* An array of numbers representing a coordinate.
* @typedef {Array.<number>} ol.Coordinate
*/
ol.Coordinate;

2
src/ol/dom/input.js
View File

@@ -18,7 +18,7 @@ ol.dom.InputProperty = {
/**
* Helper class for binding HTML input to an ol.Object
* Helper class for binding HTML input to an {@link ol.Object}.
*
* Example:
*

1
src/ol/extent.js
View File

@@ -8,6 +8,7 @@ goog.require('ol.TransformFunction');
/**
* An array of numbers representing an extent: `[minx, miny, maxx, maxy]`.
* @typedef {Array.<number>}
*/
ol.Extent;

1
src/ol/overlay.js
View File

@@ -45,6 +45,7 @@ ol.OverlayPositioning = {
* element: document.getElementById('popup')
* });
* popup.setPosition(coordinate);
* map.addOverlay(popup);
*
* @constructor
* @extends {ol.Object}

3
src/ol/proj/proj.js
View File

@@ -43,7 +43,8 @@ ol.proj.Units = {
/**
* @const {Object.<ol.proj.Units, number>} Meters per unit lookup table.
* Meters per unit lookup table.
* @const {Object.<ol.proj.Units, number>}
*/
ol.METERS_PER_UNIT = {};
ol.METERS_PER_UNIT[ol.proj.Units.DEGREES] =

2
src/ol/size.js
View File

@@ -3,7 +3,7 @@ goog.provide('ol.size');
/**
* An array representing a size: [width, height].
* An array of numbers representing a size: `[width, height]`.
* @typedef {Array.<number>} ol.Size
*/
ol.Size;