Add @api stable annotations for KML format

This commit is contained in:
Éric Lemoine
2014-08-26 10:42:47 +02:00
parent 5120248188
commit e0c173bd24
2 changed files with 8 additions and 8 deletions
+2 -2
View File
@@ -1418,7 +1418,7 @@ olx.format.KMLOptions;
/** /**
* Extract styles from the KML. Default is `true`. * Extract styles from the KML. Default is `true`.
* @type {boolean|undefined} * @type {boolean|undefined}
* @api * @api stable
*/ */
olx.format.KMLOptions.prototype.extractStyles; olx.format.KMLOptions.prototype.extractStyles;
@@ -1426,7 +1426,7 @@ olx.format.KMLOptions.prototype.extractStyles;
/** /**
* Default style. The default default style is the same as Google Earth. * Default style. The default default style is the same as Google Earth.
* @type {Array.<ol.style.Style>|undefined} * @type {Array.<ol.style.Style>|undefined}
* @api * @api stable
*/ */
olx.format.KMLOptions.prototype.defaultStyle; olx.format.KMLOptions.prototype.defaultStyle;
+6 -6
View File
@@ -64,7 +64,7 @@ ol.format.KMLGxTrackObject_;
* @constructor * @constructor
* @extends {ol.format.XMLFeature} * @extends {ol.format.XMLFeature}
* @param {olx.format.KMLOptions=} opt_options Options. * @param {olx.format.KMLOptions=} opt_options Options.
* @api * @api stable
*/ */
ol.format.KML = function(opt_options) { ol.format.KML = function(opt_options) {
@@ -1509,7 +1509,7 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @api * @api stable
*/ */
ol.format.KML.prototype.readFeature; ol.format.KML.prototype.readFeature;
@@ -1540,7 +1540,7 @@ ol.format.KML.prototype.readFeatureFromNode = function(node, opt_options) {
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api * @api stable
*/ */
ol.format.KML.prototype.readFeatures; ol.format.KML.prototype.readFeatures;
@@ -1591,7 +1591,7 @@ ol.format.KML.prototype.readFeaturesFromNode = function(node, opt_options) {
/** /**
* @param {Document|Node|string} source Souce. * @param {Document|Node|string} source Souce.
* @return {string|undefined} Name. * @return {string|undefined} Name.
* @api * @api stable
*/ */
ol.format.KML.prototype.readName = function(source) { ol.format.KML.prototype.readName = function(source) {
if (ol.xml.isDocument(source)) { if (ol.xml.isDocument(source)) {
@@ -1661,7 +1661,7 @@ ol.format.KML.prototype.readNameFromNode = function(node) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @api * @api stable
*/ */
ol.format.KML.prototype.readProjection; ol.format.KML.prototype.readProjection;
@@ -2526,7 +2526,7 @@ ol.format.KML.OUTER_BOUNDARY_NODE_FACTORY_ =
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Options. * @param {olx.format.WriteOptions=} opt_options Options.
* @return {Node} Result. * @return {Node} Result.
* @api * @api stable
*/ */
ol.format.KML.prototype.writeFeatures; ol.format.KML.prototype.writeFeatures;