Fix missing API docs

This commit is contained in:
Peter Robins
2014-08-11 09:31:07 +00:00
parent 9db936fe87
commit d9976ca207
6 changed files with 17 additions and 9 deletions

View File

@@ -22,13 +22,6 @@ olx.AttributionOptions;
olx.AttributionOptions.prototype.html; olx.AttributionOptions.prototype.html;
/**
* Tile ranges (FOR INTERNAL USE ONLY).
* @type {Object.<string, Array.<ol.TileRange>>|undefined}
*/
olx.AttributionOptions.prototype.tileRanges;
/** /**
* @typedef {{loadTilesWhileAnimating: (boolean|undefined), * @typedef {{loadTilesWhileAnimating: (boolean|undefined),
* loadTilesWhileInteracting: (boolean|undefined)}} * loadTilesWhileInteracting: (boolean|undefined)}}

3
src/ol/format.jsdoc Normal file
View File

@@ -0,0 +1,3 @@
/**
* @namespace ol.format
*/

View File

@@ -11,7 +11,9 @@ goog.require('ol.proj');
/** /**
* IGC altitude/z. One of 'barometric', 'gps', 'none'.
* @enum {string} * @enum {string}
* @api
*/ */
ol.format.IGCZ = { ol.format.IGCZ = {
BAROMETRIC: 'barometric', BAROMETRIC: 'barometric',

View File

@@ -65,17 +65,21 @@ ol.format.WFS.xmlns = 'http://www.w3.org/2000/xmlns/';
/** /**
* Number of features; bounds/extent.
* @typedef {{numberOfFeatures: number, * @typedef {{numberOfFeatures: number,
* bounds: ol.Extent}} * bounds: ol.Extent}}
* @api
*/ */
ol.format.WFS.FeatureCollectionMetadata; ol.format.WFS.FeatureCollectionMetadata;
/** /**
* Total deleted; total inserted; total updated; array of insert ids.
* @typedef {{totalDeleted: number, * @typedef {{totalDeleted: number,
* totalInserted: number, * totalInserted: number,
totalUpdated: number, * totalUpdated: number,
insertIds: Array.<string>}} * insertIds: Array.<string>}}
* @api
*/ */
ol.format.WFS.TransactionResponse; ol.format.WFS.TransactionResponse;

View File

@@ -16,7 +16,9 @@ goog.require('ol.tilegrid.WMTS');
/** /**
* Request encoding. One of 'KVP', 'REST'.
* @enum {string} * @enum {string}
* @api
*/ */
ol.source.WMTSRequestEncoding = { ol.source.WMTSRequestEncoding = {
KVP: 'KVP', // see spec §8 KVP: 'KVP', // see spec §8

View File

@@ -14,7 +14,9 @@ goog.require('ol.style.ImageState');
/** /**
* Icon anchor units. One of 'fraction', 'pixels'.
* @enum {string} * @enum {string}
* @api
*/ */
ol.style.IconAnchorUnits = { ol.style.IconAnchorUnits = {
FRACTION: 'fraction', FRACTION: 'fraction',
@@ -23,7 +25,9 @@ ol.style.IconAnchorUnits = {
/** /**
* Icon origin. One of 'bottom-left', 'bottom-right', 'top-left', 'top-right'.
* @enum {string} * @enum {string}
* @api
*/ */
ol.style.IconOrigin = { ol.style.IconOrigin = {
BOTTOM_LEFT: 'bottom-left', BOTTOM_LEFT: 'bottom-left',