Commit 95757077 authored by webchick's avatar webchick

Issue #2531690 by eiriksm: JSDoc tour module

parent 312c4201
...@@ -13,15 +13,18 @@ ...@@ -13,15 +13,18 @@
* Attaches the tour's toolbar tab behavior. * Attaches the tour's toolbar tab behavior.
* *
* It uses the query string for: * It uses the query string for:
* - tour: When ?tour=1 is present, the tour will start automatically * - tour: When ?tour=1 is present, the tour will start automatically after
* after the page has loaded. * the page has loaded.
* - tips: Pass ?tips=class in the url to filter the available tips to * - tips: Pass ?tips=class in the url to filter the available tips to the
* the subset which match the given class. * subset which match the given class.
* *
* @example * @example
* http://example.com/foo?tour=1&tips=bar * http://example.com/foo?tour=1&tips=bar
* *
* @type {Drupal~behavior} * @type {Drupal~behavior}
*
* @prop {Drupal~behaviorAttach} attach
* Attach tour functionality on `tour` events.
*/ */
Drupal.behaviors.tour = { Drupal.behaviors.tour = {
attach: function (context) { attach: function (context) {
...@@ -125,6 +128,7 @@ ...@@ -125,6 +128,7 @@
* @inheritdoc * @inheritdoc
* *
* @return {Drupal.tour.views.ToggleTourView} * @return {Drupal.tour.views.ToggleTourView}
* The `ToggleTourView` view.
*/ */
render: function () { render: function () {
// Render the visibility. // Render the visibility.
...@@ -168,6 +172,7 @@ ...@@ -168,6 +172,7 @@
* Toolbar tab click event handler; toggles isActive. * Toolbar tab click event handler; toggles isActive.
* *
* @param {jQuery.Event} event * @param {jQuery.Event} event
* The click event.
*/ */
onClick: function (event) { onClick: function (event) {
this.model.set('isActive', !this.model.get('isActive')); this.model.set('isActive', !this.model.get('isActive'));
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment