Add missing override and inheritDoc jsdoc tags

This commit is contained in:
Frederic Junod
2016-12-16 15:49:53 +01:00
committed by Guillaume Beraudo
parent 546fc97cd4
commit d59224f5eb
34 changed files with 77 additions and 37 deletions

View File

@@ -582,6 +582,7 @@ ol.format.EsriJSON.prototype.writeGeometry;
* @param {ol.geom.Geometry} geometry Geometry.
* @param {olx.format.WriteOptions=} opt_options Write options.
* @return {EsriJSONGeometry} Object.
* @override
* @api
*/
ol.format.EsriJSON.prototype.writeGeometryObject = function(geometry,
@@ -609,6 +610,7 @@ ol.format.EsriJSON.prototype.writeFeature;
* @param {ol.Feature} feature Feature.
* @param {olx.format.WriteOptions=} opt_options Write options.
* @return {Object} Object.
* @override
* @api
*/
ol.format.EsriJSON.prototype.writeFeatureObject = function(
@@ -655,6 +657,7 @@ ol.format.EsriJSON.prototype.writeFeatures;
* @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Write options.
* @return {Object} EsriJSON Object.
* @override
* @api
*/
ol.format.EsriJSON.prototype.writeFeaturesObject = function(features, opt_options) {

View File

@@ -479,6 +479,7 @@ ol.format.GeoJSON.prototype.readProjectionFromObject = function(object) {
* @param {ol.Feature} feature Feature.
* @param {olx.format.WriteOptions=} opt_options Write options.
* @return {string} GeoJSON.
* @override
* @api stable
*/
ol.format.GeoJSON.prototype.writeFeature;
@@ -490,6 +491,7 @@ ol.format.GeoJSON.prototype.writeFeature;
* @param {ol.Feature} feature Feature.
* @param {olx.format.WriteOptions=} opt_options Write options.
* @return {GeoJSONFeature} Object.
* @override
* @api stable
*/
ol.format.GeoJSON.prototype.writeFeatureObject = function(feature, opt_options) {
@@ -538,6 +540,7 @@ ol.format.GeoJSON.prototype.writeFeatures;
* @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Write options.
* @return {GeoJSONFeatureCollection} GeoJSON Object.
* @override
* @api stable
*/
ol.format.GeoJSON.prototype.writeFeaturesObject = function(features, opt_options) {
@@ -572,6 +575,7 @@ ol.format.GeoJSON.prototype.writeGeometry;
* @param {ol.geom.Geometry} geometry Geometry.
* @param {olx.format.WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry|GeoJSONGeometryCollection} Object.
* @override
* @api stable
*/
ol.format.GeoJSON.prototype.writeGeometryObject = function(geometry,

View File

@@ -1162,6 +1162,7 @@ ol.format.GML3.prototype.GEOMETRY_NODE_FACTORY_ = function(value, objectStack, o
* @param {ol.geom.Geometry} geometry Geometry.
* @param {olx.format.WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override
* @api
*/
ol.format.GML3.prototype.writeGeometryNode = function(geometry, opt_options) {
@@ -1196,6 +1197,7 @@ ol.format.GML3.prototype.writeFeatures;
* @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override
* @api
*/
ol.format.GML3.prototype.writeFeaturesNode = function(features, opt_options) {

View File

@@ -926,6 +926,7 @@ ol.format.GPX.prototype.writeFeatures;
* @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override
* @api
*/
ol.format.GPX.prototype.writeFeaturesNode = function(features, opt_options) {

View File

@@ -3018,6 +3018,7 @@ ol.format.KML.prototype.writeFeatures;
* @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override
* @api
*/
ol.format.KML.prototype.writeFeaturesNode = function(features, opt_options) {

View File

@@ -18,8 +18,7 @@ ol.inherits(ol.format.OWS, ol.format.XML);
/**
* @param {Document} doc Document.
* @return {Object} OWS object.
* @inheritDoc
*/
ol.format.OWS.prototype.readFromDocument = function(doc) {
for (var n = doc.firstChild; n; n = n.nextSibling) {
@@ -32,8 +31,7 @@ ol.format.OWS.prototype.readFromDocument = function(doc) {
/**
* @param {Node} node Node.
* @return {Object} OWS object.
* @inheritDoc
*/
ol.format.OWS.prototype.readFromNode = function(node) {
var owsObject = ol.xml.pushParseAndPop({},

View File

@@ -366,9 +366,9 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) {
/**
* Read the projection from a TopoJSON source.
*
* @function
* @param {Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection.
* @override
* @api stable
*/
ol.format.TopoJSON.prototype.readProjection = function(object) {

View File

@@ -39,8 +39,7 @@ ol.format.WMSCapabilities.prototype.read;
/**
* @param {Document} doc Document.
* @return {Object} WMS Capability object.
* @inheritDoc
*/
ol.format.WMSCapabilities.prototype.readFromDocument = function(doc) {
for (var n = doc.firstChild; n; n = n.nextSibling) {
@@ -53,8 +52,7 @@ ol.format.WMSCapabilities.prototype.readFromDocument = function(doc) {
/**
* @param {Node} node Node.
* @return {Object} WMS Capability object.
* @inheritDoc
*/
ol.format.WMSCapabilities.prototype.readFromNode = function(node) {
this.version = node.getAttribute('version').trim();

View File

@@ -41,8 +41,7 @@ ol.format.WMTSCapabilities.prototype.read;
/**
* @param {Document} doc Document.
* @return {Object} WMTS Capability object.
* @inheritDoc
*/
ol.format.WMTSCapabilities.prototype.readFromDocument = function(doc) {
for (var n = doc.firstChild; n; n = n.nextSibling) {
@@ -55,8 +54,7 @@ ol.format.WMTSCapabilities.prototype.readFromDocument = function(doc) {
/**
* @param {Node} node Node.
* @return {Object} WMTS Capability object.
* @inheritDoc
*/
ol.format.WMTSCapabilities.prototype.readFromNode = function(node) {
var version = node.getAttribute('version').trim();