Merge pull request #2471 from fredj/jsdoc

minor jsdoc and type annotation fixes
This commit is contained in:
Frédéric Junod
2014-07-31 11:14:08 +02:00
5 changed files with 11 additions and 8 deletions
+5 -5
View File
@@ -159,7 +159,7 @@ ol.format.GeoJSON.readPolygonGeometry_ = function(object) {
/** /**
* @param {ol.geom.Geometry} geometry Geometry. * @param {ol.geom.Geometry} geometry Geometry.
* @private * @private
* @return {GeoJSONObject} GeoJSON geometry. * @return {GeoJSONGeometry|GeoJSONGeometryCollection} GeoJSON geometry.
*/ */
ol.format.GeoJSON.writeGeometry_ = function(geometry) { ol.format.GeoJSON.writeGeometry_ = function(geometry) {
var geometryWriter = ol.format.GeoJSON.GEOMETRY_WRITERS_[geometry.getType()]; var geometryWriter = ol.format.GeoJSON.GEOMETRY_WRITERS_[geometry.getType()];
@@ -302,7 +302,7 @@ ol.format.GeoJSON.GEOMETRY_READERS_ = {
/** /**
* @const * @const
* @private * @private
* @type {Object.<string, function(ol.geom.Geometry): GeoJSONObject>} * @type {Object.<string, function(ol.geom.Geometry): (GeoJSONGeometry|GeoJSONGeometryCollection)>}
*/ */
ol.format.GeoJSON.GEOMETRY_WRITERS_ = { ol.format.GeoJSON.GEOMETRY_WRITERS_ = {
'Point': ol.format.GeoJSON.writePointGeometry_, 'Point': ol.format.GeoJSON.writePointGeometry_,
@@ -456,7 +456,7 @@ ol.format.GeoJSON.prototype.readProjectionFromObject = function(object) {
* *
* @function * @function
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @return {ArrayBuffer|Node|Object|string} GeoJSON. * @return {GeoJSONFeature} GeoJSON.
* @api * @api
*/ */
ol.format.GeoJSON.prototype.writeFeature; ol.format.GeoJSON.prototype.writeFeature;
@@ -492,7 +492,7 @@ ol.format.GeoJSON.prototype.writeFeatureObject = function(feature) {
* *
* @function * @function
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} GeoJSON. * @return {GeoJSONObject} GeoJSON.
* @api * @api
*/ */
ol.format.GeoJSON.prototype.writeFeatures; ol.format.GeoJSON.prototype.writeFeatures;
@@ -519,7 +519,7 @@ ol.format.GeoJSON.prototype.writeFeaturesObject = function(features) {
* *
* @function * @function
* @param {ol.geom.Geometry} geometry Geometry. * @param {ol.geom.Geometry} geometry Geometry.
* @return {ArrayBuffer|Node|Object|string} GeoJSON. * @return {GeoJSONGeometry|GeoJSONGeometryCollection} GeoJSON.
* @api * @api
*/ */
ol.format.GeoJSON.prototype.writeGeometry; ol.format.GeoJSON.prototype.writeGeometry;
+1 -1
View File
@@ -1689,7 +1689,7 @@ ol.format.GML.prototype.writeGeometryNode = function(geometry) {
* *
* @function * @function
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result. * @return {Node} Result.
* @api * @api
*/ */
ol.format.GML.prototype.writeFeatures; ol.format.GML.prototype.writeFeatures;
+1 -1
View File
@@ -845,7 +845,7 @@ ol.format.GPX.GPX_SERIALIZERS_ = ol.xml.makeStructureNS(
* *
* @function * @function
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result. * @return {Node} Result.
* @api * @api
*/ */
ol.format.GPX.prototype.writeFeatures; ol.format.GPX.prototype.writeFeatures;
+1 -1
View File
@@ -2494,7 +2494,7 @@ ol.format.KML.OUTER_BOUNDARY_NODE_FACTORY_ =
* *
* @function * @function
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result. * @return {Node} Result.
* @api * @api
*/ */
ol.format.KML.prototype.writeFeatures; ol.format.KML.prototype.writeFeatures;
+3
View File
@@ -0,0 +1,3 @@
/**
* @namespace ol.style
*/