Document change events properly

With this change, the generic 'change' event is properly documented, as
all other events. It is no longer necessary to annotate `@fires change` for
every ol.Observable subclass.
This commit is contained in:
Andreas Hocevar
2015-07-18 15:27:16 +02:00
parent 10b4aa1bab
commit 3595c2cce7
8 changed files with 32 additions and 16 deletions
+2 -1
View File
@@ -19,10 +19,11 @@ goog.require('ol.source.State');
* Layers group together those properties that pertain to how the data is to be
* displayed, irrespective of the source of that data.
*
* A generic `change` event is fired when the state of the source changes.
*
* @constructor
* @extends {ol.layer.Base}
* @fires ol.render.Event
* @fires change Triggered when the state of the source changes.
* @param {olx.layer.LayerOptions} options Layer options.
* @api stable
*/
+2 -1
View File
@@ -29,9 +29,10 @@ ol.layer.GroupProperty = {
* @classdesc
* A {@link ol.Collection} of layers that are handled together.
*
* A generic `change` event is triggered when the group/Collection changes.
*
* @constructor
* @extends {ol.layer.Base}
* @fires change Triggered when the group/Collection changes.
* @param {olx.layer.GroupOptions=} opt_options Layer options.
* @api stable
*/