From d9976ca20737687f33006b52f3bdacc6667d5eb1 Mon Sep 17 00:00:00 2001 From: Peter Robins Date: Mon, 11 Aug 2014 09:31:07 +0000 Subject: [PATCH] Fix missing API docs --- externs/olx.js | 7 ------- src/ol/format.jsdoc | 3 +++ src/ol/format/igcformat.js | 2 ++ src/ol/format/wfsformat.js | 8 ++++++-- src/ol/source/wmtssource.js | 2 ++ src/ol/style/iconstyle.js | 4 ++++ 6 files changed, 17 insertions(+), 9 deletions(-) create mode 100644 src/ol/format.jsdoc diff --git a/externs/olx.js b/externs/olx.js index 2b946d0c79..62ef7e9bde 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -22,13 +22,6 @@ olx.AttributionOptions; olx.AttributionOptions.prototype.html; -/** - * Tile ranges (FOR INTERNAL USE ONLY). - * @type {Object.>|undefined} - */ -olx.AttributionOptions.prototype.tileRanges; - - /** * @typedef {{loadTilesWhileAnimating: (boolean|undefined), * loadTilesWhileInteracting: (boolean|undefined)}} diff --git a/src/ol/format.jsdoc b/src/ol/format.jsdoc new file mode 100644 index 0000000000..d70dd02b50 --- /dev/null +++ b/src/ol/format.jsdoc @@ -0,0 +1,3 @@ +/** + * @namespace ol.format + */ diff --git a/src/ol/format/igcformat.js b/src/ol/format/igcformat.js index c96cbe3d53..f59d403c29 100644 --- a/src/ol/format/igcformat.js +++ b/src/ol/format/igcformat.js @@ -11,7 +11,9 @@ goog.require('ol.proj'); /** + * IGC altitude/z. One of 'barometric', 'gps', 'none'. * @enum {string} + * @api */ ol.format.IGCZ = { BAROMETRIC: 'barometric', diff --git a/src/ol/format/wfsformat.js b/src/ol/format/wfsformat.js index 2f64506664..76fa7c6c86 100644 --- a/src/ol/format/wfsformat.js +++ b/src/ol/format/wfsformat.js @@ -65,17 +65,21 @@ ol.format.WFS.xmlns = 'http://www.w3.org/2000/xmlns/'; /** + * Number of features; bounds/extent. * @typedef {{numberOfFeatures: number, * bounds: ol.Extent}} + * @api */ ol.format.WFS.FeatureCollectionMetadata; /** + * Total deleted; total inserted; total updated; array of insert ids. * @typedef {{totalDeleted: number, * totalInserted: number, - totalUpdated: number, - insertIds: Array.}} + * totalUpdated: number, + * insertIds: Array.}} + * @api */ ol.format.WFS.TransactionResponse; diff --git a/src/ol/source/wmtssource.js b/src/ol/source/wmtssource.js index a9ed21da7f..66dc260421 100644 --- a/src/ol/source/wmtssource.js +++ b/src/ol/source/wmtssource.js @@ -16,7 +16,9 @@ goog.require('ol.tilegrid.WMTS'); /** + * Request encoding. One of 'KVP', 'REST'. * @enum {string} + * @api */ ol.source.WMTSRequestEncoding = { KVP: 'KVP', // see spec ยง8 diff --git a/src/ol/style/iconstyle.js b/src/ol/style/iconstyle.js index 518577d3cf..e7f20f2120 100644 --- a/src/ol/style/iconstyle.js +++ b/src/ol/style/iconstyle.js @@ -14,7 +14,9 @@ goog.require('ol.style.ImageState'); /** + * Icon anchor units. One of 'fraction', 'pixels'. * @enum {string} + * @api */ ol.style.IconAnchorUnits = { FRACTION: 'fraction', @@ -23,7 +25,9 @@ ol.style.IconAnchorUnits = { /** + * Icon origin. One of 'bottom-left', 'bottom-right', 'top-left', 'top-right'. * @enum {string} + * @api */ ol.style.IconOrigin = { BOTTOM_LEFT: 'bottom-left',