From a433f1abbebc9d0f1cac6a37cb605521b0ace52b Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Thu, 23 Apr 2015 20:26:37 +0200 Subject: [PATCH] Add basic docs for attributioncontrol --- src/ol/control/attributioncontrol.js | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/ol/control/attributioncontrol.js b/src/ol/control/attributioncontrol.js index 037fbff346..3e64e77c10 100644 --- a/src/ol/control/attributioncontrol.js +++ b/src/ol/control/attributioncontrol.js @@ -210,6 +210,7 @@ ol.control.Attribution.prototype.getSourceAttributions = function(frameState) { /** + * Update the attribution element. * @param {ol.MapEvent} mapEvent Map event. * @this {ol.control.Attribution} * @api @@ -365,6 +366,7 @@ ol.control.Attribution.prototype.handleToggle_ = function() { /** + * Return `true` if the attribution is collapsible, `false` otherwise. * @return {boolean} True if the widget is collapsible. * @api stable */ @@ -374,6 +376,7 @@ ol.control.Attribution.prototype.getCollapsible = function() { /** + * Set whether the attribution should be collapsible. * @param {boolean} collapsible True if the widget is collapsible. * @api stable */ @@ -390,6 +393,9 @@ ol.control.Attribution.prototype.setCollapsible = function(collapsible) { /** + * Collapse or expand the attribution according to the passed parameter. Will + * not do anything if the attribution isn't collapsible or if the current + * collapsed state is already the one requested. * @param {boolean} collapsed True if the widget is collapsed. * @api stable */ @@ -402,6 +408,8 @@ ol.control.Attribution.prototype.setCollapsed = function(collapsed) { /** + * Return `true` when the attribution is currently collapsed or `false` + * otherwise. * @return {boolean} True if the widget is collapsed. * @api stable */