Fix missing API docs

openlayers · Aug 11, 2014 · d9976ca · d9976ca
1 parent 9db936f
commit d9976ca
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 9 deletions.
diff --git 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.<string, Array.<ol.TileRange>>|undefined}
- */
-olx.AttributionOptions.prototype.tileRanges;
-
-
 /**
  * @typedef {{loadTilesWhileAnimating: (boolean|undefined),
  *     loadTilesWhileInteracting: (boolean|undefined)}}

diff --git a/src/ol/format.jsdoc 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
@@ -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
@@ -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.<string>}}
+ *            totalUpdated: number,
+ *            insertIds: Array.<string>}}
+ * @api
  */
 ol.format.WFS.TransactionResponse;
 

diff --git 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
@@ -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',