ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add basic documentation to @api symbols

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

10
src/ol/source/source.js
View File

@@ -90,6 +90,7 @@ ol.source.Source.prototype.forEachFeatureAtCoordinate =
/**
* Get the attributions of the source.
* @return {Array.<ol.Attribution>} Attributions.
* @api stable
*/
@@ -99,6 +100,7 @@ ol.source.Source.prototype.getAttributions = function() {
/**
* Get the logo of the source.
* @return {string|olx.LogoOptions|undefined} Logo.
* @api stable
*/
@@ -108,6 +110,7 @@ ol.source.Source.prototype.getLogo = function() {
/**
* Get the projection of the source.
* @return {ol.proj.Projection} Projection.
* @api
*/
@@ -123,6 +126,7 @@ ol.source.Source.prototype.getResolutions = goog.abstractMethod;
/**
* Get the state of the source, see {@link ol.source.State} for possible states.
* @return {ol.source.State} State.
* @api
*/
@@ -132,6 +136,7 @@ ol.source.Source.prototype.getState = function() {
/**
* Set the attributions of the source.
* @param {Array.<ol.Attribution>} attributions Attributions.
*/
ol.source.Source.prototype.setAttributions = function(attributions) {
@@ -140,6 +145,7 @@ ol.source.Source.prototype.setAttributions = function(attributions) {
/**
* Set the logo of the source.
* @param {string|olx.LogoOptions|undefined} logo Logo.
*/
ol.source.Source.prototype.setLogo = function(logo) {
@@ -148,6 +154,7 @@ ol.source.Source.prototype.setLogo = function(logo) {
/**
* Set the state of the source.
* @param {ol.source.State} state State.
* @protected
*/
@@ -158,7 +165,8 @@ ol.source.Source.prototype.setState = function(state) {
/**
* @param {ol.proj.Projection} projection Projetion.
* Set the projection of the source.
* @param {ol.proj.Projection} projection Projection.
*/
ol.source.Source.prototype.setProjection = function(projection) {
this.projection_ = projection;