diff options
author | webchick | 2015-08-29 06:32:45 (GMT) |
---|---|---|
committer | webchick | 2015-08-29 06:32:45 (GMT) |
commit | 95757077293ae67eda9b5f79d1ebd460feccc936 (patch) | |
tree | 3068daf86d0f3ec3af7dfa76eefbcc33334899f6 | |
parent | 312c420193c0471628d5239194115bec48cc6bc1 (diff) |
Issue #2531690 by eiriksm: JSDoc tour module
-rw-r--r-- | core/modules/tour/js/tour.js | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/core/modules/tour/js/tour.js b/core/modules/tour/js/tour.js index d6ca172..c751329 100644 --- a/core/modules/tour/js/tour.js +++ b/core/modules/tour/js/tour.js @@ -13,15 +13,18 @@ * Attaches the tour's toolbar tab behavior. * * It uses the query string for: - * - tour: When ?tour=1 is present, the tour will start automatically - * after the page has loaded. - * - tips: Pass ?tips=class in the url to filter the available tips to - * the subset which match the given class. + * - tour: When ?tour=1 is present, the tour will start automatically after + * the page has loaded. + * - tips: Pass ?tips=class in the url to filter the available tips to the + * subset which match the given class. * * @example * http://example.com/foo?tour=1&tips=bar * * @type {Drupal~behavior} + * + * @prop {Drupal~behaviorAttach} attach + * Attach tour functionality on `tour` events. */ Drupal.behaviors.tour = { attach: function (context) { @@ -125,6 +128,7 @@ * @inheritdoc * * @return {Drupal.tour.views.ToggleTourView} + * The `ToggleTourView` view. */ render: function () { // Render the visibility. @@ -168,6 +172,7 @@ * Toolbar tab click event handler; toggles isActive. * * @param {jQuery.Event} event + * The click event. */ onClick: function (event) { this.model.set('isActive', !this.model.get('isActive')); |