Add basic documentation to @api symbols

This commit is contained in:
Marc Jansen
2015-04-17 22:38:29 +02:00
parent eff48c026a
commit 99e39fe06e
15 changed files with 41 additions and 2 deletions

View File

@@ -166,6 +166,7 @@ ol.source.ImageMapGuide.prototype.getImage =
/**
* Return the image load function of the source.
* @return {ol.ImageLoadFunctionType} The image load function.
* @api
*/
@@ -176,7 +177,7 @@ ol.source.ImageMapGuide.prototype.getImageLoadFunction = function() {
/**
* @param {ol.Extent} extent The map extents.
* @param {ol.Size} size the viewport size.
* @param {ol.Size} size The viewport size.
* @param {number} metersPerUnit The meters-per-unit value.
* @param {number} dpi The display resolution.
* @return {number} The computed map scale.
@@ -238,6 +239,7 @@ ol.source.ImageMapGuide.prototype.getUrl =
/**
* Set the image load function of the MapGuide source.
* @param {ol.ImageLoadFunctionType} imageLoadFunction Image load function.
* @api
*/