Add minimal comments to satisfy jsdoc3.

This commit is contained in:
Tom Payne
2012-09-21 10:08:29 +02:00
parent 397ebca228
commit 5f0c90cf7e
8 changed files with 13 additions and 0 deletions

View File

@@ -91,6 +91,7 @@ goog.inherits(ol3.Collection, ol3.Object);
/**
* Remove all elements from the collection.
*/
ol3.Collection.prototype.clear = function() {
while (this[ol3.CollectionProperty.LENGTH]) {

View File

@@ -244,6 +244,7 @@ ol3.Map.prototype.fitUserExtent = function(userExtent) {
/**
* Freeze rendering.
*/
ol3.Map.prototype.freezeRendering = function() {
++this.freezeRenderingCount_;
@@ -586,6 +587,7 @@ ol3.Map.prototype.recalculateTransforms_ = function() {
/**
* Render.
*/
ol3.Map.prototype.render = function() {
if (this.animatingCount_ < 1) {
@@ -752,6 +754,7 @@ goog.exportProperty(
/**
* Start animating.
*/
ol3.Map.prototype.startAnimating = function() {
if (++this.animatingCount_ == 1) {
@@ -764,6 +767,7 @@ ol3.Map.prototype.startAnimating = function() {
/**
* Stop animating.
*/
ol3.Map.prototype.stopAnimating = function() {
goog.asserts.assert(this.animatingCount_ > 0);
@@ -777,6 +781,7 @@ ol3.Map.prototype.stopAnimating = function() {
/**
* Unfreeze rendering.
*/
ol3.Map.prototype.unfreezeRendering = function() {
goog.asserts.assert(this.freezeRenderingCount_ > 0);

View File

@@ -29,6 +29,7 @@ goog.inherits(ol3.MapEvent, goog.events.Event);
/**
* Prevents the default action.
*/
ol3.MapEvent.prototype.preventDefault = function() {
goog.base(this, 'preventDefault');

View File

@@ -257,6 +257,7 @@ ol3.Object.prototype.unbind = function(key) {
/**
* Removes all bindings.
*/
ol3.Object.prototype.unbindAll = function() {
var listeners = ol3.Object.getListeners(this);

View File

@@ -70,6 +70,7 @@ ol3.renderer.dom.Layer.prototype.handleLayerVisibleChange = function() {
/**
* Render.
*/
ol3.renderer.dom.Layer.prototype.render = goog.abstractMethod;

View File

@@ -197,6 +197,7 @@ ol3.renderer.Map.prototype.getPixelFromCoordinate = function(coordinate) {
/**
* Handle background color changed.
*/
ol3.renderer.Map.prototype.handleBackgroundColorChanged = goog.nullFunction;

View File

@@ -105,10 +105,12 @@ ol3.renderer.webgl.Layer.prototype.handleLayerVisibleChange = function() {
/**
* Handle webglcontextlost.
*/
ol3.renderer.webgl.Layer.prototype.handleWebGLContextLost = goog.nullFunction;
/**
* Render.
*/
ol3.renderer.webgl.Layer.prototype.render = goog.abstractMethod;

View File

@@ -132,6 +132,7 @@ ol3.Tile.prototype.handleImageLoad_ = function() {
/**
* Load.
*/
ol3.Tile.prototype.load = function() {
if (this.state_ == ol3.TileState.IDLE) {